Package io.guise.framework.platform.web

Class WebHeadingDepictor<C extends LabelComponent>

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

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

Type Parameters:

C - The type of component being depicted.

All Implemented Interfaces:

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

public class WebHeadingDepictor<C extends LabelComponent>
extends WebLabelDepictor<C>

Strategy for rendering a label component as an XHTML h1, h2, etc. element. If a heading level corresponds to one of the XHTML heading element names, that name will be used for the element; otherwise, the span element will be used. If no style ID is provided, the default style ID will be used with the heading level, if given, appended.

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

Modifier and Type	Field	Description
protected static final String[]	HEADING_LOCAL_NAMES	The array of XHTML heading element local names.

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
WebHeadingDepictor()

Method Summary

Modifier and Type	Method	Description
static String	getHeadingLocalName(int headingLevel)	Determines the local name to use for a heading based upon a heading level.
String	getLocalName()	Determines the local name of the XML element.

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

depictBody

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, depictEnd, getBackgroundColor, getBaseStyleIDs, getBodyStyleIDs, getBodyStyles, getColor, getDepictContext, getDepictName, getLabelStyles, getLabelStyles, getLabelStyles, 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, processEvent, 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, processEvent, setDepicted, uninstalled

Field Details

HEADING_LOCAL_NAMES

protected static final String[] HEADING_LOCAL_NAMES

The array of XHTML heading element local names.

Constructor Details

WebHeadingDepictor

public WebHeadingDepictor()

Method Details

getLocalName

public String getLocalName()

Determines the local name of the XML element.

This version returns one of the XHTML heading element local names if the component is a HeadingComponent and a valid level is specified, otherwise the default local name is returned.

Overrides:

getLocalName in class AbstractWebComponentDepictor<C extends LabelComponent>

Returns:

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

See Also:

• Heading.getLevel()
• getHeadingLocalName(int)

getHeadingLocalName

public static String getHeadingLocalName(int headingLevel)

Determines the local name to use for a heading based upon a heading level. This method returns one of the XHTML heading element local names if a valid level is specified.

Parameters:

headingLevel - The zero-based level of the heading, or HeadingComponent.NO_HEADING_LEVEL if no level is specified.

Returns:

The appropriate XHTML heading element name if a level is specified, or null if there is no heading local name for the given heading level.