Package io.guise.framework.platform.web

Class WebTextBoxDepictor<C extends TextBox>

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

Type Parameters:

C - The type of component being depicted.

All Implemented Interfaces:

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

public class WebTextBoxDepictor<C extends TextBox>
extends AbstractSimpleWebComponentDepictor<C>

Strategy for rendering a text component as an XHTML <div> element or, based upon TextBox.getTextContentType(), a specialized XHTML element.

Author:

Garret Wilson

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	WebTextBoxDepictor.CachedDocument	Cached information associating a pre-parsed XML document with a string.

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

Method Summary

Modifier and Type	Method	Description
protected void	depictChildren()	Depicts any child components.
java.lang.String	getLocalName()	Determines the local name of the XML element.
protected void	updateElement(org.w3c.dom.Element element)	Renders an XML element.
protected void	updateElementContent(org.w3c.dom.Element element)	Renders the content of an XML element.

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

WebTextBoxDepictor

public WebTextBoxDepictor()

Default constructor using the XHTML <div> element.

Method Detail

getLocalName

public java.lang.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 TextBox>

Returns:

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

depictChildren

protected void depictChildren()
                       throws java.io.IOException

Depicts any child components.

This version does not call the super version, because all child rendering is controlled by this version.

Overrides:

depictChildren in class AbstractComponentDepictor<C extends TextBox>

Throws:

java.io.IOException - if there is an error updating the child depictions.

updateElement

protected void updateElement(org.w3c.dom.Element element)
                      throws java.io.IOException

Renders an XML element. If there is a child component with constraints indicating the same ID as this element, that child component will be rendered in place of this element.

Parameters:

element - The element the content of which should be rendered.

Throws:

java.io.IOException - if there is an error rendering the component.

updateElementContent

protected void updateElementContent(org.w3c.dom.Element element)
                             throws java.io.IOException

Renders the content of an XML element.

Parameters:

element - The element the content of which should be rendered.

Throws:

java.io.IOException - if there is an error rendering the component.