Package io.guise.framework.platform.web
Class AbstractSimpleWebComponentDepictor<C extends Component>
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>
- Type Parameters:
C
- The type of component being depicted.
- All Implemented Interfaces:
ComponentDepictor<C>
,Depictor<C>
,WebComponentDepictor<C>
,WebDepictor<C>
- Direct Known Subclasses:
AbstractWebActionControlDepictor
,WebFlashDepictor
,WebIFrameLikeButtonDepictor
,WebImageDepictor
,WebLabelDepictor
,WebListDepictor
,WebTextBoxDepictor
public abstract class AbstractSimpleWebComponentDepictor<C extends Component>
extends AbstractWebComponentDepictor<C>
A component depictor that uses its top-level XHTML element as its main or body component.
- 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
ConstructorDescriptionDefault constructor with no element representation.AbstractSimpleWebComponentDepictor
(URI namespaceURI, String localName) Element namespace and local name constructor that doesn't create an empty element, even if there is no content.AbstractSimpleWebComponentDepictor
(URI namespaceURI, String localName, boolean isEmptyElementAllowed) Element namespace and local name constructor. -
Method Summary
Modifier and TypeMethodDescriptionprotected void
Begins the depiction process.Retrieves the styles for the outer element of the component.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, 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, 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
-
AbstractSimpleWebComponentDepictor
public AbstractSimpleWebComponentDepictor()Default constructor with no element representation. -
AbstractSimpleWebComponentDepictor
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, ornull
if there is no namespace.localName
- The local name of the element with no prefix, ornull
if this component should not be rendered as an element.
-
AbstractSimpleWebComponentDepictor
public AbstractSimpleWebComponentDepictor(URI namespaceURI, String localName, boolean isEmptyElementAllowed) Element namespace and local name constructor.- Parameters:
namespaceURI
- The URI of the XML namespace of the element, ornull
if there is no namespace.localName
- The local name of the element with no prefix, ornull
if this component should not be rendered as an element.isEmptyElementAllowed
- Whether an empty element can be created if there is no content.
-
-
Method Details
-
getOuterStyles
Retrieves the styles for the outer element of the component.This version returns the style for color.
This version combines the body styles with the outer styles.
- Overrides:
getOuterStyles
in classAbstractWebComponentDepictor<C extends Component>
- Returns:
- The styles for the outer element of the component, mapped to CSS property names.
-
depictBegin
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.
- Overrides:
depictBegin
in classAbstractWebComponentDepictor<C extends Component>
- Throws:
IOException
- if there is an error updating the depiction.
-