Package io.guise.framework.platform.web

Class WebSliderDepictor<V extends java.lang.Number,C extends SliderControl<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.WebSliderDepictor<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 WebSliderDepictor<V extends java.lang.Number,C extends SliderControl<V>>
extends AbstractWebComponentDepictor<C>

Strategy for rendering a slider component as an XHTML <slider> 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 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
WebSliderDepictor()	Default constructor using the XHTML <div> element.

Method Summary

Modifier and Type	Method	Description
protected void	depictBegin()	Begins the depiction process.
protected void	depictBody()	Depicts the body of the component.
void	depictEnd()	Ends the depiction process.
protected java.util.Set<java.lang.String>	getBaseStyleIDs(java.lang.String prefix, java.lang.String suffix)	Retrieves the base style IDs for the given component.
void	processEvent(PlatformEvent event)	Processes an event from the platform.
static <V extends java.lang.Number> void	processPosition(SliderControl<V> sliderControl, double position)	Updates the position of a slider control based upon the relative position sent from the web platform.

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

addFlowStyleIDs, decorateID, depict, getBackgroundColor, 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, 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

Constructor Detail

WebSliderDepictor

public WebSliderDepictor()

Default constructor using the XHTML <div> element.

Method Detail

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 extends java.lang.Number>

Overrides:

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

Parameters:

event - The event to be processed.

processPosition

public static <V extends java.lang.Number> void processPosition(SliderControl<V> sliderControl,
                                                                double position)

Updates the position of a slider control based upon the relative position sent from the web platform.

Type Parameters:

V - The type of value contained in the control.

Parameters:

sliderControl - The slider control.

position - The relative position of the slider.

Throws:

java.lang.NullPointerException - if the given control and/or value class is null.

getBaseStyleIDs

protected java.util.Set<java.lang.String> getBaseStyleIDs(java.lang.String prefix,
                                                          java.lang.String suffix)

Retrieves the base style IDs for the given component.

This version returns the default style ID and the specified component style ID, if any.

If the component is Selectable and is selected, the GuiseCSSStyleConstants.SELECTED_CLASS is returned.

This version adds attributes based upon the slider axis and orientation, as well as whether the slider is sliding.

Overrides:

getBaseStyleIDs in class AbstractWebComponentDepictor<C extends SliderControl<V>>

Parameters:

prefix - The prefix that needs to be added to each, or null if there is no prefix to add.

suffix - The suffix that needs to be added to each, or null if there is no suffix to add.

Returns:

The base style IDs for the component.

See Also:

AbstractWebComponentDepictor.addFlowStyleIDs(Set, Flow), GuiseCSSStyleConstants.SLIDER_SLIDING_CLASS

depictBegin

protected void depictBegin()
                    throws java.io.IOException

Description copied from class: AbstractWebComponentDepictor

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.

Overrides:

depictBegin in class AbstractWebComponentDepictor<C extends SliderControl<V>>

Throws:

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

depictBody

protected void depictBody()
                   throws java.io.IOException

Description copied from class: AbstractWebComponentDepictor

Depicts the body of the component.

This version depicts the children of the component.

This version increases and decreases the indention level before and after depicting the children, respectively.

Overrides:

depictBody in class AbstractWebComponentDepictor<C extends SliderControl<V>>

Throws:

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

See Also:

AbstractComponentDepictor.depictChildren()

depictEnd

public void depictEnd()
               throws java.io.IOException

Description copied from class: AbstractWebComponentDepictor

Ends the depiction process.

This version renders the ending XML element information, if there is any.

Overrides:

depictEnd in class AbstractWebComponentDepictor<C extends SliderControl<V>>

Throws:

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