Package io.guise.framework.platform.web

Class WebResourceCollectDepictor<C extends ResourceCollectControl>

java.lang.Object

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

io.guise.framework.platform.AbstractComponentDepictor<C>

io.guise.framework.platform.web.AbstractWebComponentDepictor<C>

io.guise.framework.platform.web.AbstractDecoratedWebComponentDepictor<C>

io.guise.framework.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

Nested Classes

Modifier and Type	Class	Description
static class	WebResourceCollectDepictor.ResourceCollectCommand	The web commands for controlling a resource collect control.

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

AbstractComponentDepictor.DepictedCompositeComponentListener

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

AbstractDepictor.DepictedPropertyChangeListener

Field Summary

Fields inherited from class io.guise.framework.platform.web.AbstractWebComponentDepictor

BODY_END_PATTERN, BODY_START_PATTERN

Fields inherited from class io.guise.framework.platform.AbstractComponentDepictor

childPropertyChangeListener

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

GENERAL_PROPERTY

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	cancel()	Requests that resource collection be canceled.
protected void	depictBegin()	Begins the depiction 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 io.guise.framework.platform.web.AbstractDecoratedWebComponentDepictor

depictEnd, getBodyLocalName, getBodyNamespaceURI, isEmptyBodyElementAllowed, writeDecoratorEnd

Methods inherited from class io.guise.framework.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 io.guise.framework.platform.AbstractComponentDepictor

depictChild, depictChildren, getDepictedCompositeComponentListener, getErrorMessage, installed, uninstalled

Methods inherited from class io.guise.framework.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 io.guise.framework.platform.Depictor

depict, getDepictedObject, 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)

Description copied from interface: ResourceCollectControl.Depictor

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.

cancel

public void cancel()

Description copied from interface: ResourceCollectControl.Depictor

Requests that resource collection be canceled.

Specified by:

cancel in interface ResourceCollectControl.Depictor<C extends ResourceCollectControl>

processEvent

public void processEvent(PlatformEvent event)

Description copied from class: AbstractComponentDepictor

Processes an event from the platform.

This implementation handles PlatformFocusEvent.

Specified by:

processEvent in interface Depictor<C extends ResourceCollectControl>

Overrides:

processEvent in class AbstractComponentDepictor<C extends ResourceCollectControl>

Parameters:

event - The event to be processed.

depictedObjectPropertyChange

protected void depictedObjectPropertyChange(java.beans.PropertyChangeEvent propertyChangeEvent)

Called when a depicted object bound property is changed.

This method may also be called for objects related to the depicted object, so if specific properties are checked the event source should be verified to be the depicted object.

This implementation marks the property as being modified if the property is not an ignored property.

This implementation marks the property as being modified if the property is not an ignored property.

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 writes the beginning decorator items, such as the label, if any.

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

Description copied from class: AbstractDecoratedWebComponentDepictor

Begins the depiction process.

This version renders the beginning XML element information, if there is any, leaving the beginning tag open for attributes.

This version writes common XHTML attributes.

This version calls AbstractDecoratedWebComponentDepictor.writeDecoratorBegin().

Overrides:

depictBegin in class AbstractDecoratedWebComponentDepictor<C extends ResourceCollectControl>

Throws:

java.io.IOException - if there is an error updating the depiction.