Package io.guise.framework.platform.web

Class WebPanelDepictor<C extends Panel>

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

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

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

Type Parameters:

C - The type of component being depicted.

All Implemented Interfaces:

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

public class WebPanelDepictor<C extends Panel>
extends WebLayoutComponentDepictor<C>

Strategy for rendering a panel as an XHTML <div> element.

This implementation recognizes panels that are also SectionComponents, and uses the appropriate XHTML element for the SectionComponent.getSectionType() indicated. A utility method is also provided for other depictors wishing to determine the appropriate XHTML element for a SectionComponent.SectionType.

Changes to LabelModel.LABEL_PROPERTY are ignored.

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.AbstractWebLayoutComponentDepictor

COLUMN_REGION_CLASSES, ROW_REGION_CLASSES

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
WebPanelDepictor()	Default constructor.

Method Summary

Modifier and Type	Method	Description
String	getLocalName()	Determines the local name of the XML element.
static String	getLocalName(SectionComponent.SectionType sectionType)	Determines the appropriate XHTML element local name (e.g.

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

depictBegin, getOuterStyles

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

beginRegion, beginRegion, depictChildren, getAlign, updateFlowChildView

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

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

Constructor Details

WebPanelDepictor

public WebPanelDepictor()

Default constructor.

Method Details

getLocalName

public String getLocalName()

Determines the local name of the XML element.

This version returns special section elements if the component is a SectionComponent with a non-null section type.

Overrides:

getLocalName in class AbstractWebComponentDepictor<C extends Panel>

Returns:

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

getLocalName

@Nonnull
public static String getLocalName(@Nonnull
 SectionComponent.SectionType sectionType)

Determines the appropriate XHTML element local name (e.g. <section>) for the given section type. If there is no specific XHTML element appropriate for the given section type, "div" will be returned.

Parameters:

sectionType - The type of section indicated.

Returns:

The XHTML element local name for the indicated section type.

Throws:

NullPointerException - if the given section type is null.