Package io.guise.framework.platform.web

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

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

Type Parameters:

C - The type of component being depicted.

All Implemented Interfaces:

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

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

Strategy for rendering an action model control as an XHTML <a> element containing a heading. For the component to be rendered at the correct heading level it must be a HeadingComponent. 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

See Also:

• WebHeadingDepictor

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

Method Summary

Modifier and Type	Method	Description
protected void	depictBegin()	Begins the depiction process.
protected void	depictEnd()	Ends the depiction process.

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

depictBody, getNavigateActionListener, writeSupplementaryIcons

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

WebHeadingLinkDepictor

public WebHeadingLinkDepictor()

Default constructor using the XHTML <a> element.

Method Details

depictBegin

protected void depictBegin()
                    throws 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.

This version starts the inner heading element.

Overrides:

depictBegin in class WebLinkDepictor<C extends ActionControl>

Throws:

IOException - if there is an error updating the depiction.

See Also:

• WebHeadingDepictor.getHeadingLocalName(int)

depictEnd

protected void depictEnd()
                  throws IOException

Ends the depiction process.

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

This version ends the inner heading element.

Overrides:

depictEnd in class AbstractWebComponentDepictor<C extends ActionControl>

Throws:

IOException - if there is an error updating the depiction.

See Also:

• WebHeadingDepictor.getHeadingLocalName(int)