com.guiseframework.platform
Interface PlatformFileCollector.Depictor<F extends PlatformFileCollector>

Type Parameters:

F - The type of file reference list to be depicted.

All Superinterfaces:

Depictor<F>

All Known Implementing Classes:

AbstractWebPlatformFileCollectorDepictor, DefaultWebPlatformFileCollectorDepictor

Enclosing class:

PlatformFileCollector

public static interface PlatformFileCollector.Depictor<F extends PlatformFileCollector>
extends Depictor<F>

The custom depictor type for this depicted object class.

Author:

Garret Wilson

Field Summary

Fields inherited from interface com.guiseframework.platform.Depictor

GENERAL_PROPERTY

Method Summary

void	browse() Requests that user be displayed a dialog for browsing files.
void	cancel(PlatformFile platformFile) Cancels a platform file upload or download.
void	upload(PlatformFile platformFile, java.net.URI destinationURI) Initiates a platform file upload.

Methods inherited from interface com.guiseframework.platform.Depictor

depict, getDepictContext, getDepictedObject, getPlatform, getSession, installed, isDepicted, processEvent, setDepicted, uninstalled

Method Detail

browse

void browse()

Requests that user be displayed a dialog for browsing files.

cancel

void cancel(PlatformFile platformFile)

Cancels a platform file upload or download.

Parameters:

platformFile - Thet platform file to cancel.

Throws:

java.lang.NullPointerException - if the given platform file is null.

java.lang.IllegalStateException - the specified platform file can no longer be canceled because, for example, other platform files have since been selected.

upload

void upload(PlatformFile platformFile,
            java.net.URI destinationURI)

Initiates a platform file upload.

Parameters:

platformFile - Thet platform file to upload.

destinationURI - The URI representing the destination of the platform file, either absolute or relative to the application.

Throws:

java.lang.NullPointerException - if the given platform file and/or destination URI is null.