Package io.guise.framework.platform.web

Class AbstractWebPlatformFileCollectorDepictor

java.lang.Object

io.guise.framework.platform.AbstractDepictor<O>

io.guise.framework.platform.web.AbstractWebDepictor<PlatformFileCollector>

io.guise.framework.platform.web.AbstractWebPlatformFileCollectorDepictor

All Implemented Interfaces:

Depictor<PlatformFileCollector>, PlatformFileCollector.Depictor<PlatformFileCollector>

Direct Known Subclasses:

DefaultWebPlatformFileCollectorDepictor

public class AbstractWebPlatformFileCollectorDepictor
extends AbstractWebDepictor<PlatformFileCollector>
implements PlatformFileCollector.Depictor<PlatformFileCollector>

An abstract depictor for a collector of platform files for the web platform.

Author:

Garret Wilson

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractWebPlatformFileCollectorDepictor.WebPlatformFileCollectorCommand	The web commands for controlling the platform file collector.

Nested classes/interfaces inherited from class io.guise.framework.platform.AbstractDepictor

AbstractDepictor.DepictedPropertyChangeListener

Field Summary

Fields inherited from interface io.guise.framework.platform.Depictor

GENERAL_PROPERTY

Constructor Summary

Constructors

Constructor	Description
AbstractWebPlatformFileCollectorDepictor()

Method Summary

Modifier and Type	Method	Description
void	browse()	Requests that user be displayed a dialog for browsing files.
void	cancel(PlatformFile platformFile)	Cancels a platform file upload or download.
WebPlatformFile	getPlatformFile(java.lang.String id)	Retrieves a platform file by the ID assigned to it.
void	processEvent(PlatformEvent event)	Processes an event from the platform.
void	upload(PlatformFile platformFile, java.net.URI destinationURI)	Initiates a platform file upload.

Methods inherited from class io.guise.framework.platform.web.AbstractWebDepictor

getPlatform

Methods inherited from class io.guise.framework.platform.AbstractDepictor

depict, depictedObjectPropertyChange, getDepictContext, getDepictedObject, getDepictedPropertyChangeListener, getIgnoredProperties, getModifiedProperties, getSession, installed, isDepicted, setDepicted, setPropertyModified, uninstalled

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.guise.framework.platform.Depictor

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

Constructor Detail

AbstractWebPlatformFileCollectorDepictor

public AbstractWebPlatformFileCollectorDepictor()

Method Detail

getPlatformFile

public WebPlatformFile getPlatformFile(java.lang.String id)

Retrieves a platform file by the ID assigned to it.

Parameters:

id - The ID assigned to the platform file.

Returns:

The specified platform file, or null if there is no platforom file with the given ID.

Throws:

java.lang.NullPointerException - if the given ID is null.

browse

public void browse()

Description copied from interface: PlatformFileCollector.Depictor

Requests that user be displayed a dialog for browsing files.

Specified by:

browse in interface PlatformFileCollector.Depictor<PlatformFileCollector>

cancel

public void cancel(PlatformFile platformFile)

Description copied from interface: PlatformFileCollector.Depictor

Cancels a platform file upload or download.

Specified by:

cancel in interface PlatformFileCollector.Depictor<PlatformFileCollector>

Parameters:

platformFile - Thet platform file to cancel.

upload

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

Description copied from interface: PlatformFileCollector.Depictor

Initiates a platform file upload.

Specified by:

upload in interface PlatformFileCollector.Depictor<PlatformFileCollector>

Parameters:

platformFile - Thet platform file to upload.

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

processEvent

public void processEvent(PlatformEvent event)

Description copied from interface: Depictor

Processes an event from the platform.

Specified by:

processEvent in interface Depictor<PlatformFileCollector>

Overrides:

processEvent in class AbstractDepictor<PlatformFileCollector>

Parameters:

event - The event to be processed.