.. _dojox/widget/FilePicker:

dojox.widget.FilePicker
========================

:Status: Draft
:Version: 1.2
:Project owner: Nathan Toone
:Available: since V1.3

.. contents::
   :depth: 1

A specialized version of RollingList that handles file information


============
Introduction
============

The file picker extends the rolling list to add file-specific styling (folder/file icons), as well as the concept of file system heirarchy.

=====
Usage
=====

Creating a file picker is similar to creating a rolling list.  In addition to the options for rolling list, you can specify the following:
 * **pathSeparator** The path separator to use - it will be guessed if not provided
 * **topDir** the top-level directory to provide access to - it will be guessed if not provided
 * **pathAttr** the attribute to read for getting the full path of the file
 * ``New in 1.3`` **selectDirectories** whether or not you want to allow selecting of directories
 * ``New in 1.3`` **selectFiles** whether or not you want to allow selecting of files

=====================
Additional attr value
=====================

You can call widget.attr("pathValue") to get (or set) the value of the widget - using "string" format (ie. "/path/to/file.txt") instead of using the item

========
Examples
========

A simple file picker pulling data from a dojox.data.FileStore
-------------------------------------------------------------

.. cv-compound ::

  .. cv :: javascript

    <script>
      dojo.require("dojox.data.FileStore");
      dojo.require("dojox.widget.FilePicker");
    </script>

  .. cv :: html
  
    <div dojoType="dojox.data.FileStore" jsId="fileStore" pathAsQueryParam="true"
        url="/_static/dojo/dojox/data/demos/stores/filestore_dojotree.php"></div>
    <div dojoType="dojox.widget.FilePicker" store="fileStore" query="{}" style="height:150px;width:50%"></div>

  .. cv:: css

    <style type="text/css">
      @import "/_static/dojo/dojox/widget/FilePicker/FilePicker.css";
    </style>