org.xul.script.xul.model.file

Class FilePicker

java.lang.Object

org.mozilla.javascript.ScriptableObject

org.xul.script.xul.model.file.FilePicker

All Implemented Interfaces:

java.io.Serializable, org.mozilla.javascript.ConstProperties, org.mozilla.javascript.debug.DebuggableObject, org.mozilla.javascript.Scriptable, org.mozilla.javascript.SymbolScriptable

public class FilePicker
extends org.mozilla.javascript.ScriptableObject

A file picker which can be used in a script.

Since:

1.0

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.mozilla.javascript.ScriptableObject

org.mozilla.javascript.ScriptableObject.KeyComparator

Field Summary

Fields

Modifier and Type	Field and Description
static int	RETURN_CANCEL The cancel option for the return value.
static int	RETURN_OK The approve option for the return value.

Fields inherited from class org.mozilla.javascript.ScriptableObject

CONST, DONTENUM, EMPTY, PERMANENT, READONLY, UNINITIALIZED_CONST

Fields inherited from interface org.mozilla.javascript.Scriptable

NOT_FOUND

Constructor Summary

Constructors

Constructor and Description
FilePicker()

Method Summary

Modifier and Type	Method and Description
boolean	appendFilters(java.lang.String desc, java.lang.String extensions) Append file filters to the FilePicker.
java.io.File	displayDirectory()
java.lang.String	getClassName()
java.io.File	getFile() Return the selected file.
void	init(java.lang.Object parent, java.lang.String title, java.lang.String mode) Initialize the FilePicker.
void	init(XULWidget widget, java.lang.String title, java.lang.String mode) Initialize the FilePicker.
java.io.File	jsGet_displayDirectory()
java.io.File	jsGet_file()
int	jsGet_returnCancel() The cancel return value.
int	jsGet_returnOK() The OK return value for the Javascript usage of the FilePicker.
void	jsSet_displayDirectory(java.lang.String value)
void	setDisplayDirectory(java.io.File dir) Set the current directory.
void	setDisplayDirectory(java.lang.Object dir) Set the current directory.
int	show() Show the dialog.

Methods inherited from class org.mozilla.javascript.ScriptableObject

applyDescriptorToAttributeBitset, associateValue, avoidObjectDetection, buildDataDescriptor, callMethod, callMethod, checkPropertyChange, checkPropertyDefinition, defineClass, defineClass, defineClass, defineConst, defineConstProperty, defineFunctionProperties, defineOwnProperties, defineOwnProperty, defineOwnProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, delete, delete, delete, deleteProperty, deleteProperty, ensureScriptable, ensureScriptableObject, ensureSymbolScriptable, equivalentValues, get, get, get, get, getAllIds, getArrayPrototype, getAssociatedValue, getAttributes, getAttributes, getAttributes, getAttributes, getAttributes, getClassPrototype, getDefaultValue, getDefaultValue, getExternalArrayData, getExternalArrayLength, getFunctionPrototype, getGeneratorFunctionPrototype, getGetterOrSetter, getIds, getObjectPrototype, getOwnPropertyDescriptor, getParentScope, getProperty, getProperty, getProperty, getPropertyIds, getPrototype, getSlot, getTopLevelScope, getTopScopeValue, getTypedProperty, getTypedProperty, getTypeOf, has, has, has, hasInstance, hasProperty, hasProperty, hasProperty, isAccessorDescriptor, isConst, isDataDescriptor, isEmpty, isExtensible, isFalse, isGenericDescriptor, isGetterOrSetter, isSealed, isTrue, preventExtensions, put, put, put, putConst, putConstProperty, putProperty, putProperty, putProperty, redefineProperty, sameValue, sealObject, setAttributes, setAttributes, setAttributes, setAttributes, setAttributes, setExternalArrayData, setGetterOrSetter, setParentScope, setPrototype, size

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

RETURN_OK

public static final int RETURN_OK

The approve option for the return value.

See Also:

Constant Field Values

RETURN_CANCEL

public static final int RETURN_CANCEL

The cancel option for the return value.

See Also:

Constant Field Values

Constructor Detail

FilePicker

@JSConstructor
public FilePicker()

Method Detail

init

public void init(XULWidget widget,
                 java.lang.String title,
                 java.lang.String mode)

Initialize the FilePicker.

Parameters:

widget - the parent widget

title - the title of the dialog

mode - the mode:

• "modeOpen" for an Open dialog
• "modeSave" for a save dialog

init

@JSFunction
public void init(java.lang.Object parent,
                              java.lang.String title,
                              java.lang.String mode)

Initialize the FilePicker.

Parameters:

parent - the parent executor

title - the title of the dialog

mode - the mode:

• "modeOpen" for an Open dialog
• "modeSave" for a save dialog

appendFilters

@JSFunction
public boolean appendFilters(java.lang.String desc,
                                          java.lang.String extensions)

Append file filters to the FilePicker. For example:

 appendFilters("The text files", "*.txt");
 appendFilters("The XUL and XML files", "*.xul; *.xml");
 

Parameters:

desc - the description

extensions - the extensions

Returns:

true if the filter definition was correct and could be added.

setDisplayDirectory

public void setDisplayDirectory(java.io.File dir)

Set the current directory.

Parameters:

dir - the current directory

setDisplayDirectory

@JSFunction
public void setDisplayDirectory(java.lang.Object dir)

Set the current directory. Must be a File.

Parameters:

dir - the current directory

getFile

@JSFunction
public java.io.File getFile()

Return the selected file.

Returns:

the selected file

show

@JSFunction
public int show()

Show the dialog. Will return RETURN_OK or RETURN_OK.

Returns:

the return value

jsGet_returnOK

public int jsGet_returnOK()

The OK return value for the Javascript usage of the FilePicker.

Returns:

0

jsGet_returnCancel

public int jsGet_returnCancel()

The cancel return value.

Returns:

0

jsGet_file

public java.io.File jsGet_file()

displayDirectory

public java.io.File displayDirectory()

jsGet_displayDirectory

public java.io.File jsGet_displayDirectory()

jsSet_displayDirectory

public void jsSet_displayDirectory(java.lang.String value)

getClassName

public java.lang.String getClassName()

Specified by:

getClassName in interface org.mozilla.javascript.Scriptable

Specified by:

getClassName in class org.mozilla.javascript.ScriptableObject