org.eclipse.scout.rt.client.ui.basic.filechooser

Class FileChooser

java.lang.Object

org.eclipse.scout.rt.client.ui.basic.filechooser.FileChooser

All Implemented Interfaces:

IFileChooser

public class FileChooser
extends Object
implements IFileChooser

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	FileChooser.P_UIFacade

Field Summary

Fields inherited from interface org.eclipse.scout.rt.client.ui.basic.filechooser.IFileChooser

DEFAULT_MAXIMUM_UPLOAD_SIZE

Constructor Summary

Constructors

Constructor and Description
FileChooser()
FileChooser(boolean multiSelect)
FileChooser(Collection<String> fileExtensions)
FileChooser(Collection<String> fileExtensions, boolean multiSelect)

Method Summary

Modifier and Type	Method and Description
void	addFileChooserListener(FileChooserListener listener)
protected void	fireClosed()
protected void	fireFileChooserEvent(FileChooserEvent e)
IDisplayParent	getDisplayParent()
List<String>	getFileExtensions()
List<org.eclipse.scout.rt.platform.resource.BinaryResource>	getFiles()
long	getMaximumUploadSize()
IFileChooserUIFacade	getUIFacade()
boolean	isMultiSelect()
void	removeFileChooserListener(FileChooserListener listener)
void	setDisplayParent(IDisplayParent displayParent) Sets the display parent to attach this IFileChooser to.
void	setFiles(List<org.eclipse.scout.rt.platform.resource.BinaryResource> result) Sets the result and releases the blocking condition held by IFileChooser.startChooser().
void	setMaximumUploadSize(long maximumUploadSize)
List<org.eclipse.scout.rt.platform.resource.BinaryResource>	startChooser() start file choosing and block until a result is available

Methods inherited from class java.lang.Object

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

Constructor Detail

FileChooser

public FileChooser()

FileChooser

public FileChooser(boolean multiSelect)

FileChooser

public FileChooser(Collection<String> fileExtensions)

FileChooser

public FileChooser(Collection<String> fileExtensions,
                   boolean multiSelect)

Method Detail

getUIFacade

public IFileChooserUIFacade getUIFacade()

Specified by:

getUIFacade in interface IFileChooser

getDisplayParent

public IDisplayParent getDisplayParent()

Specified by:

getDisplayParent in interface IFileChooser

Returns:

the IDisplayParent to attach this IFileChooser to; is never null.

setDisplayParent

public void setDisplayParent(IDisplayParent displayParent)

Description copied from interface: IFileChooser

Sets the display parent to attach this IFileChooser to.

A display parent is the anchor to attach this IFileChooser to, and affects its accessibility and modality scope. Possible parents are IDesktop, IOutline, or IForm:

• Desktop: IFileChooser is always accessible; blocks the entire desktop;
• Outline: IFileChooser is only accessible when the given outline is active; only blocks the outline;
• Form: IFileChooser is only accessible when the given Form is active; only blocks the Form;

Specified by:

setDisplayParent in interface IFileChooser

Parameters:

displayParent - like IDesktop, IOutline, IForm, or null to derive the IDisplayParent from the current calling context.

addFileChooserListener

public void addFileChooserListener(FileChooserListener listener)

Specified by:

addFileChooserListener in interface IFileChooser

removeFileChooserListener

public void removeFileChooserListener(FileChooserListener listener)

Specified by:

removeFileChooserListener in interface IFileChooser

getFileExtensions

public List<String> getFileExtensions()

Specified by:

getFileExtensions in interface IFileChooser

Returns:

a list containing any of media types, mime types and file extensions.

media and mime types are specified using at least a subtype (such containing a '/')

File extensions are specified without leading '.'

Example 1: [txt, csv, text/xml]

Example 2: [text/plain, text/csv, xml]

isMultiSelect

public boolean isMultiSelect()

Specified by:

isMultiSelect in interface IFileChooser

setMaximumUploadSize

public void setMaximumUploadSize(long maximumUploadSize)

Specified by:

setMaximumUploadSize in interface IFileChooser

Parameters:

maximumUploadSize - maximum size for upload in bytes.

getMaximumUploadSize

public long getMaximumUploadSize()

Specified by:

getMaximumUploadSize in interface IFileChooser

Returns:

maximum size for upload in bytes

startChooser

public List<org.eclipse.scout.rt.platform.resource.BinaryResource> startChooser()

Description copied from interface: IFileChooser

start file choosing and block until a result is available

Specified by:

startChooser in interface IFileChooser

Returns:

IFileChooser.getFiles()

setFiles

public void setFiles(List<org.eclipse.scout.rt.platform.resource.BinaryResource> result)

Description copied from interface: IFileChooser

Sets the result and releases the blocking condition held by IFileChooser.startChooser().

Specified by:

setFiles in interface IFileChooser

getFiles

public List<org.eclipse.scout.rt.platform.resource.BinaryResource> getFiles()

Specified by:

getFiles in interface IFileChooser

Returns:

list of previously uploaded files using IFileChooser.startChooser() (empty list if chooser was not yet started)

fireClosed

protected void fireClosed()

fireFileChooserEvent

protected void fireFileChooserEvent(FileChooserEvent e)