Package io.guise.framework.platform.web

Class AbstractWebActionControlDepictor<C extends ActionControl>

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.AbstractSimpleWebComponentDepictor<C>

io.guise.framework.platform.web.AbstractWebActionControlDepictor<C>

Type Parameters:

C - The type of component being depicted.

All Implemented Interfaces:

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

Direct Known Subclasses:

WebButtonDepictor, WebCustomButtonDepictor, WebLinkDepictor

public abstract class AbstractWebActionControlDepictor<C extends ActionControl>
extends AbstractSimpleWebComponentDepictor<C>

Abstract depictor for rendering simple action controls in XHTML. By default this implementation ignores changes in the ActionControl.ROLLOVER_PROPERTY property when determining whether to update the control. Depictors that wish to update the control upon rollover change must (besides implementing changing of the rollover property) remove the rollover property from the list of ignored properties, AbstractDepictor.getIgnoredProperties().

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
AbstractWebActionControlDepictor()	Default constructor with no element representation.
AbstractWebActionControlDepictor(java.net.URI namespaceURI, java.lang.String localName)	Element namespace and local name constructor that doesn't create an empty element, even if there is no content.
AbstractWebActionControlDepictor(java.net.URI namespaceURI, java.lang.String localName, boolean isEmptyElementAllowed)	Element namespace and local name constructor.

Method Summary

Modifier and Type	Method	Description
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.
protected java.util.Map<java.lang.String,java.lang.Object>	getBodyStyles()	Retrieves the styles for the body element of the component.
void	processEvent(PlatformEvent event)	Processes an event from the platform.

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

depictBegin, getOuterStyles

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

addFlowStyleIDs, decorateID, depict, depictBody, depictEnd, getBackgroundColor, getBodyStyleIDs, getColor, getDepictContext, getDepictName, getLabelStyles, getLabelStyles, getLabelStyles, getLocalName, getNamespaceURI, 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

AbstractWebActionControlDepictor

public AbstractWebActionControlDepictor()

Default constructor with no element representation.

AbstractWebActionControlDepictor

public AbstractWebActionControlDepictor(java.net.URI namespaceURI,
                                        java.lang.String localName)

Element namespace and local name constructor that doesn't create an empty element, even if there is no content.

Parameters:

namespaceURI - The URI of the XML namespace of the element, or null if there is no namespace.

localName - The local name of the element with no prefix, or null if this component should not be rendered as an element.

AbstractWebActionControlDepictor

public AbstractWebActionControlDepictor(java.net.URI namespaceURI,
                                        java.lang.String localName,
                                        boolean isEmptyElementAllowed)

Element namespace and local name constructor.

Parameters:

namespaceURI - The URI of the XML namespace of the element, or null if there is no namespace.

localName - The local name of the element with no prefix, or null if this component should not be rendered as an element.

isEmptyElementAllowed - Whether an empty element can be created if there is no content.

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<C extends ActionControl>

Overrides:

processEvent in class AbstractComponentDepictor<C extends ActionControl>

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 an attribute for selected status if the control is a select action control with a selected model. This version also adds an attribute if the component is disabled.

Overrides:

getBaseStyleIDs in class AbstractWebComponentDepictor<C extends ActionControl>

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.

getBodyStyles

protected java.util.Map<java.lang.String,java.lang.Object> getBodyStyles()

Retrieves the styles for the body element of the component.

This version returns the style for background color.

This version lowers the opacity if the control is disabled.

Overrides:

getBodyStyles in class AbstractWebComponentDepictor<C extends ActionControl>

Returns:

The styles for the body element of the component, mapped to CSS property names.