Package io.guise.framework.platform.web

Class WebTabDepictor<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.WebTabDepictor<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 WebTabDepictor<V,C extends ListSelectControl<V>>
extends AbstractDecoratedWebComponentDepictor<C>

Strategy for rendering a tabbed control as an XHTML <ol> element containing tabs. This view supports TabControl and TabContainerControl.

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

Method Summary

Modifier and Type	Method	Description
protected void	depictBody()	Depicts the body of the component.
protected void	depictChildren()	Depicts any child components.
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.

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

depictBegin, depictEnd, getBodyLocalName, getBodyNamespaceURI, isEmptyBodyElementAllowed, writeDecoratorBegin, writeDecoratorEnd

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

WebTabDepictor

public WebTabDepictor()

Default constructor using the XHTML <ol> 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>

Overrides:

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

Parameters:

event - The event to be processed.

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 tab control axis and orientation.

Overrides:

getBaseStyleIDs in class AbstractWebComponentDepictor<C extends ListSelectControl<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)

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

Throws:

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

See Also:

AbstractComponentDepictor.depictChildren()

depictChildren

protected void depictChildren()
                       throws java.io.IOException

Depicts any child components.

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

Overrides:

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

Throws:

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