com.guiseframework.platform.web
Class WebSliderDepictor<V extends java.lang.Number,C extends SliderControl<V>>

java.lang.Object
  com.guiseframework.platform.AbstractDepictor<C>
      com.guiseframework.platform.AbstractComponentDepictor<C>
          com.guiseframework.platform.web.AbstractWebComponentDepictor<C>
              com.guiseframework.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 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

WebSliderDepictor()
Default constructor using the XHTML <div> element.

Method Summary

protected void	depictBegin() Begins the rendering process.
protected void	depictBody() Renders the body of the component.
void	depictEnd() Ends the rendering 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 com.guiseframework.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 com.guiseframework.platform.AbstractComponentDepictor

depictChild, depictChildren, 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

Constructor Detail

WebSliderDepictor

public WebSliderDepictor()

Default constructor using the XHTML <div> element.

Method Detail

processEvent

public void processEvent(PlatformEvent event)

Processes an event from the platform.

Specified by:

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

Overrides:

processEvent in class AbstractComponentDepictor<C extends SliderControl<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.

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 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#SLIDING_CLASS

depictBegin

protected void depictBegin()
                    throws java.io.IOException

Begins the rendering process.

Overrides:

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

Throws:

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

java.lang.IllegalArgumentException - if the given value control represents a value type this controller doesn't support.

depictBody

protected void depictBody()
                   throws java.io.IOException

Renders the body of the component.

Overrides:

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

Throws:

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

See Also:

AbstractComponentDepictor.depictChildren()

depictEnd

public void depictEnd()
               throws java.io.IOException

Ends the rendering process.

Overrides:

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

Throws:

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