Package io.guise.framework.platform.web
Class AbstractDecoratedWebComponentDepictor<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.AbstractDecoratedWebComponentDepictor<C>
- Type Parameters:
C
- The type of component being depicted.
- All Implemented Interfaces:
ComponentDepictor<C>
,Depictor<C>
,WebComponentDepictor<C>
,WebDepictor<C>
- Direct Known Subclasses:
WebFileInputDepictor
,WebMessageDepictor
,WebResourceCollectDepictor
,WebSelectDepictor
,WebTabDepictor
,WebTextControlDepictor
,WebTreeControlDepictor
public abstract class AbstractDecoratedWebComponentDepictor<C extends Component>
extends AbstractWebComponentDepictor<C>
An abstract XHTML component depictor that writes component decorations such as label and error. The component is wrapped in an ourter XHTML
<div>
element. The body of the component will be preceded by a label and succeeded by an error. The provided element, if any, will be used
as the body of the component with the GuiseCSSStyleConstants.COMPONENT_BODY_CLASS_SUFFIX
ID and style suffix.- 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 for the body.AbstractDecoratedWebComponentDepictor
(URI namespaceURI, String localName) Body element namespace and local name constructor that doesn't create an empty element, even if there is no content.AbstractDecoratedWebComponentDepictor
(URI bodyNamespaceURI, String bodyLocalName, boolean isBodyEmptyElementAllowed) Body element namespace and local name constructor. -
Method Summary
Modifier and TypeMethodDescriptionprotected void
Begins the depiction process.protected void
Ends the depiction process.Determines the local name of the body XML element.Determines the namespace URI of the body XML element.boolean
Determines whether an empty body element can be created if there is no content.protected void
Writes the beginning part of the outer decorator element.protected void
Writes the ending part of the outer decorator element.Methods inherited from class io.guise.framework.platform.web.AbstractWebComponentDepictor
addFlowStyleIDs, decorateID, depict, depictBody, getBackgroundColor, getBaseStyleIDs, getBodyStyleIDs, getBodyStyles, getColor, getDepictContext, getDepictName, getLabelStyles, getLabelStyles, getLabelStyles, getLocalName, getNamespaceURI, getOuterStyles, 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
-
AbstractDecoratedWebComponentDepictor
public AbstractDecoratedWebComponentDepictor()Default constructor with no element representation for the body. -
AbstractDecoratedWebComponentDepictor
Body 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.
-
AbstractDecoratedWebComponentDepictor
public AbstractDecoratedWebComponentDepictor(URI bodyNamespaceURI, String bodyLocalName, boolean isBodyEmptyElementAllowed) Body element namespace and local name constructor.- Parameters:
bodyNamespaceURI
- The URI of the XML namespace of the body element, ornull
if there is no namespace.bodyLocalName
- The local name of the body element with no prefix, ornull
if this component should not be rendered as an element.isBodyEmptyElementAllowed
- Whether an empty body element can be created if there is no content.
-
-
Method Details
-
getBodyNamespaceURI
Determines the namespace URI of the body XML element.- Returns:
- The URI of the XML namespace of the element, or
null
if there is no namespace.
-
getBodyLocalName
Determines the local name of the body XML element.- Returns:
- The local name of the element with no prefix, or
null
if this component should not be rendered as an element.
-
isEmptyBodyElementAllowed
public boolean isEmptyBodyElementAllowed()Determines whether an empty body element can be created if there is no content.- Returns:
- Whether an empty body element can be created if there is no content.
- See Also:
-
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 calls
writeDecoratorBegin()
.- Overrides:
depictBegin
in classAbstractWebComponentDepictor<C extends Component>
- Throws:
IOException
- if there is an error updating the depiction.
-
writeDecoratorBegin
Writes the beginning part of the outer decorator element. This version writes the beginning decorator items, such as the label, if any.- Throws:
IOException
- if there is an error rendering the component.
-
depictEnd
Ends the depiction process.This version renders the ending XML element information, if there is any.
This version calls
writeDecoratorEnd()
.- Overrides:
depictEnd
in classAbstractWebComponentDepictor<C extends Component>
- Throws:
IOException
- if there is an error updating the depiction.
-
writeDecoratorEnd
Writes the ending part of the outer decorator element. This version writes the ending decorator items, such as the error message, if any.- Throws:
IOException
- if there is an error rendering the component.- See Also:
-