com.guiseframework.platform.web
Class WebResourceCollectDepictor<C extends ResourceCollectControl>

java.lang.Object
  com.guiseframework.platform.AbstractDepictor<C>
      com.guiseframework.platform.AbstractComponentDepictor<C>
          com.guiseframework.platform.web.AbstractWebComponentDepictor<C>
              com.guiseframework.platform.web.AbstractDecoratedWebComponentDepictor<C>
                  com.guiseframework.platform.web.WebResourceCollectDepictor<C>

Type Parameters:

C - The type of component being depicted.

All Implemented Interfaces:

ResourceCollectControl.Depictor<C>, ComponentDepictor<C>, Depictor<C>, WebComponentDepictor<C>, WebDepictor<C>

public class WebResourceCollectDepictor<C extends ResourceCollectControl>
extends AbstractDecoratedWebComponentDepictor<C>
implements ResourceCollectControl.Depictor<C>

Strategy for rendering a resource collect control as an XHTML <input> element with type="file".

Author:

Garret Wilson

Nested Class Summary

static class

WebResourceCollectDepictor.ResourceCollectCommand The web commands for controlling a resource collect control.

Nested classes/interfaces inherited from class com.guiseframework.platform.AbstractComponentDepictor

AbstractComponentDepictor.DepictedCompositeComponentListener

Nested classes/interfaces inherited from class com.guiseframework.platform.AbstractDepictor

AbstractDepictor.DepictedPropertyChangeListener

Field Summary

Fields inherited from class com.guiseframework.platform.web.AbstractWebComponentDepictor

BODY_END_PATTERN, BODY_START_PATTERN

Fields inherited from class com.guiseframework.platform.AbstractComponentDepictor

childPropertyChangeListener

Fields inherited from interface com.guiseframework.platform.Depictor

GENERAL_PROPERTY

Constructor Summary

WebResourceCollectDepictor()
Default constructor using the XHTML <input> element.

Method Summary

void	cancel() Requests that resource collection be canceled.
protected void	depictBegin() Begins the rendering process.
protected void	depictedObjectPropertyChange(java.beans.PropertyChangeEvent propertyChangeEvent) Called when a depicted object bound property is changed.
void	processEvent(PlatformEvent event) Processes an event from the platform.
void	receive(java.net.URI destinationURI, Bookmark destinationBookmark) Requests that resource collection start.
protected void	writeDecoratorBegin() Writes the beginning part of the outer decorator element.

Methods inherited from class com.guiseframework.platform.web.AbstractDecoratedWebComponentDepictor

depictEnd, getBodyLocalName, getBodyNamespaceURI, isEmptyBodyElementAllowed, writeDecoratorEnd

Methods inherited from class com.guiseframework.platform.web.AbstractWebComponentDepictor

addFlowStyleIDs, decorateID, depict, depictBody, getBackgroundColor, getBaseStyleIDs, getBodyStyleIDs, getBodyStyles, getColor, getDepictContext, getDepictName, getLabelStyles, getLabelStyles, getLabelStyles, getLocalName, getNamespaceURI, getOuterStyles, getPlatform, hasLabelContent, hasLabelContent, hasLabelContent, hasLabelContent, isEmptyElementAllowed, isMouseListener, writeBodyIDClassAttributes, writeClassAttribute, writeDirectionAttribute, writeDirectionAttribute, writeErrorMessage, writeFloatClear, writeIDAttribute, writeIDClassAttributes, writeLabel, writeLabelContent, writeLabelContent, writeLabelContent, writeLabelContent, writeLabelContent, writeLabelContent, writeParameterInputs, writeStyleAttribute, writeText

Methods inherited from class com.guiseframework.platform.AbstractComponentDepictor

depictChild, depictChildren, getDepictedCompositeComponentListener, getErrorMessage, installed, uninstalled

Methods inherited from class com.guiseframework.platform.AbstractDepictor

getDepictedObject, getDepictedPropertyChangeListener, getIgnoredProperties, getModifiedProperties, getSession, isDepicted, setDepicted, setPropertyModified

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.guiseframework.platform.Depictor

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

Constructor Detail

WebResourceCollectDepictor

public WebResourceCollectDepictor()

Default constructor using the XHTML <input> element.

Method Detail

receive

public void receive(java.net.URI destinationURI,
                    Bookmark destinationBookmark)

Requests that resource collection start.

Specified by:

receive in interface ResourceCollectControl.Depictor<C extends ResourceCollectControl>

Parameters:

destinationURI - The URI representing the destination of the collected resources, relative to the application.

destinationBookmark - The bookmark to be used in receiving the resources at the destination path, or null if no bookmark should be used.

Throws:

java.lang.NullPointerException - if the given destination URI is null.

cancel

public void cancel()

Requests that resource collection be canceled.

Specified by:

cancel in interface ResourceCollectControl.Depictor<C extends ResourceCollectControl>

processEvent

public void processEvent(PlatformEvent event)

Processes an event from the platform.

Specified by:

processEvent in interface Depictor<C extends ResourceCollectControl>

Overrides:

processEvent in class AbstractComponentDepictor<C extends ResourceCollectControl>

Parameters:

event - The event to be processed.

Throws:

java.lang.IllegalArgumentException - if the given event is a relevant DepictEvent with a source of a different depicted object.

depictedObjectPropertyChange

protected void depictedObjectPropertyChange(java.beans.PropertyChangeEvent propertyChangeEvent)

Called when a depicted object bound property is changed. This implementation marks the property as being modified if the property is not an ignored property.

Overrides:

depictedObjectPropertyChange in class AbstractComponentDepictor<C extends ResourceCollectControl>

Parameters:

propertyChangeEvent - An event object describing the event source and the property that has changed.

See Also:

AbstractDepictor.getIgnoredProperties(), AbstractDepictor.setPropertyModified(String, boolean)

writeDecoratorBegin

protected void writeDecoratorBegin()
                            throws java.io.IOException

Writes the beginning part of the outer decorator element. This version write additional patching attributes.

Overrides:

writeDecoratorBegin in class AbstractDecoratedWebComponentDepictor<C extends ResourceCollectControl>

Throws:

java.io.IOException - if there is an error rendering the component.

depictBegin

protected void depictBegin()
                    throws java.io.IOException

Begins the rendering process.

Overrides:

depictBegin in class AbstractDecoratedWebComponentDepictor<C extends ResourceCollectControl>

Throws:

java.io.IOException - if there is an error rendering the component.