Package io.guise.framework.platform.web

Class WebSelectDepictor<V,C extends ListSelectControl<V>>

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

AbstractComponentDepictor.DepictedCompositeComponentListener

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

AbstractDepictor.DepictedPropertyChangeListener

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	GUISE_DUMMY_NULL_VALUE	The value for indicating a dummy null value when no value is selected.

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
WebSelectDepictor()	Default constructor using the XHTML <select> element.

Method Summary

Modifier and Type	Method	Description
protected void	depictBegin()	Begins the depiction process.
protected void	depictChildren()	Depicts any child components.
void	processEvent(PlatformEvent event)	Processes an event from the platform.
static <V> void	processSelectedIDs(ListSelectControl<V> selectControl, String[] selectedIDs)	Updates the selection of a list select control based upon the selected IDs sent from the web platform.

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

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

getDepictedObject, getSession, installed, isDepicted, setDepicted, uninstalled

Field Details

GUISE_DUMMY_NULL_VALUE

protected static final String GUISE_DUMMY_NULL_VALUE

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

See Also:

• Constant Field Values

Constructor Details

WebSelectDepictor

public WebSelectDepictor()

Default constructor using the XHTML <select> element.

Method Details

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<V>

Overrides:

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

Parameters:

event - The event to be processed.

processSelectedIDs

public static <V> void processSelectedIDs(ListSelectControl<V> selectControl,
 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:

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

depictBegin

protected void depictBegin()
                    throws 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 ListSelectControl<V>>

Throws:

IOException - if there is an error updating the depiction.

depictChildren

protected void depictChildren()
                       throws IOException

Depicts any child components.

This version does nothing, because if a list select control is a composite component the child controls have already been rendered as values in AbstractWebComponentDepictor.depictBody().

Overrides:

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

Throws:

IOException - if there is an error updating the child depictions.