Package io.guise.framework.platform.web

Class WebLinkDepictor<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>

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

Type Parameters:

C - The type of component being depicted.

All Implemented Interfaces:

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

Direct Known Subclasses:

WebHeadingLinkDepictor, WebImageActionControlDepictor, WebSelectLinkDepictor

public class WebLinkDepictor<C extends ActionControl>
extends AbstractWebActionControlDepictor<C>

Strategy for rendering an action model control as an XHTML <a> element. If a link has a NavigateActionListener as one of its action listeners, the generated href URI will be that of the listener, and a target attribute will be set of the listener specifies a viewport ID.

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

Method Summary

Modifier and Type	Method	Description
protected void	depictBegin()	Begins the depiction process.
protected void	depictBody()	Depicts the body of the component.
static AbstractNavigateActionListener	getNavigateActionListener(ActionControl actionControl)	Retrieves the first NavigateActionListener or ModalNavigationListener registered with the given action control, if any.
protected void	writeSupplementaryIcons()	Writes the supplementary icons.

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

getBaseStyleIDs, getBodyStyles, processEvent

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

getOuterStyles

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

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

WebLinkDepictor

public WebLinkDepictor()

Default constructor using the XHTML <a> element.

Method Detail

depictBegin

protected void depictBegin()
                    throws java.io.IOException

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 writes the body ID and class attributes, along with the direction attribute.

This version renders any component info as a link title.

Overrides:

depictBegin in class AbstractSimpleWebComponentDepictor<C extends ActionControl>

Throws:

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

getNavigateActionListener

public static AbstractNavigateActionListener getNavigateActionListener(ActionControl actionControl)

Retrieves the first NavigateActionListener or ModalNavigationListener registered with the given action control, if any. This action listener is useful for determining whether predetermined navigation action is called for. If more than one navigate action listener is registered with the given action control, it is undefined which will be returned.

Parameters:

actionControl - The action control used to look for the registered listener.

Returns:

An action listener registered with the action control with predefined semantics for navigation, or null if no such action listener is registered with the control.

depictBody

protected void depictBody()
                   throws java.io.IOException

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.

This version renders any label information.

Overrides:

depictBody in class AbstractWebComponentDepictor<C extends ActionControl>

Throws:

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

See Also:

AbstractComponentDepictor.depictChildren()

writeSupplementaryIcons

protected void writeSupplementaryIcons()
                                throws java.io.IOException

Writes the supplementary icons. If no supplementary icons are present, no action occurs. This version does nothing.

Throws:

java.io.IOException - if there is an error writing the icons.