com.guiseframework.platform.web
Class WebSelectDepictor<V,C extends ListSelectControl<V>>

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.WebSelectDepictor<V,C>

Type Parameters:

V - The type of values to select.

C - The type of component being depicted.

All Implemented Interfaces:

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

public class WebSelectDepictor<V,C extends ListSelectControl<V>>
extends AbstractDecoratedWebComponentDepictor<C>

Strategy for rendering a select control as an XHTML <select> element.

Author:

Garret Wilson

Nested Class Summary

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

protected static java.lang.String

GUISE_DUMMY_NULL_VALUE The value for indicating a dummy null value when no value is selected.

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

WebSelectDepictor()
Default constructor using the XHTML <select> element.

Method Summary

protected void	depictBegin() Begins the rendering process.
protected void	depictChildren() Updates the views of any children.
void	processEvent(PlatformEvent event) Processes an event from the platform.
static <V> void	processSelectedIDs(ListSelectControl<V> selectControl, java.lang.String[] selectedIDs) Updates the selection of a list select control based upon the selected IDs sent from the web platform.

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

depictEnd, getBodyLocalName, getBodyNamespaceURI, isEmptyBodyElementAllowed, writeDecoratorBegin, 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, depictedObjectPropertyChange, 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

getDepictedObject, getSession, installed, isDepicted, setDepicted, uninstalled

Field Detail

GUISE_DUMMY_NULL_VALUE

protected static final java.lang.String GUISE_DUMMY_NULL_VALUE

The value for indicating a dummy null value when no value is selected.

See Also:

Constant Field Values

Constructor Detail

WebSelectDepictor

public WebSelectDepictor()

Default constructor using the XHTML <select> element.

Method Detail

processEvent

public void processEvent(PlatformEvent event)

Processes an event from the platform.

Specified by:

processEvent in interface Depictor<C extends ListSelectControl<V>>

Overrides:

processEvent in class AbstractComponentDepictor<C extends ListSelectControl<V>>

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.

processSelectedIDs

public static <V> void processSelectedIDs(ListSelectControl<V> selectControl,
                                          java.lang.String[] selectedIDs)

Updates the selection of a list select control based upon the selected IDs sent from the web platform.

Type Parameters:

V - The type of value contained in the control.

Parameters:

selectControl - The select control.

selectedIDs - The array of new selected IDs, each identifying a representation component of the value.

Throws:

java.lang.NullPointerException - if the given control and/or selected IDs is null.

depictBegin

protected void depictBegin()
                    throws java.io.IOException

Begins the rendering process.

Overrides:

depictBegin in class AbstractDecoratedWebComponentDepictor<C extends ListSelectControl<V>>

Throws:

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

depictChildren

protected void depictChildren()
                       throws java.io.IOException

Updates the views of any children. This version does nothing, because if a list select control is a composite component the child controls have already been rendered as values in #depictBody(XMLGuiseContext, ListSelectControl).

Overrides:

depictChildren in class AbstractComponentDepictor<C extends ListSelectControl<V>>

Throws:

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