Package io.guise.framework.platform.web

Class AbstractWebFrameDepictor<C extends Frame>

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

Type Parameters:

C - The type of component being depicted.

All Implemented Interfaces:

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

Direct Known Subclasses:

WebApplicationFrameDepictor, WebFrameDepictor

public class AbstractWebFrameDepictor<C extends Frame>
extends AbstractWebComponentDepictor<C>

Abstract strategy for rendering a frame as a series of XHTML elements. If the session changes a property, such as locale, orientation, or principal, it is assumed that the entire frame needs updating. This depictor ignores changes to the InputFocusGroupComponent.INPUT_FOCUS_STRATEGY_PROPERTY and InputFocusGroupComponent.INPUT_FOCUSED_COMPONENT_PROPERTY properties.

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

Constructors

Constructor	Description
AbstractWebFrameDepictor()	Default constructor with no element representation.
AbstractWebFrameDepictor(java.net.URI namespaceURI, java.lang.String localName)	Element namespace and local name constructor that doesn't create an empty element, even if there is no content.
AbstractWebFrameDepictor(java.net.URI namespaceURI, java.lang.String localName, boolean isEmptyElementAllowed)	Element namespace and local name constructor.

Method Summary

Modifier and Type	Method	Description
protected void	depictBody()	Depicts the body of the component.
void	installed(C component)	Called when the depictor is installed in a depicted object.
void	uninstalled(C component)	Called when the depictor is uninstalled from a depicted object.

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

addFlowStyleIDs, decorateID, depict, depictBegin, depictEnd, 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, processEvent

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, isDepicted, processEvent, setDepicted

Constructor Detail

AbstractWebFrameDepictor

public AbstractWebFrameDepictor()

Default constructor with no element representation.

AbstractWebFrameDepictor

public AbstractWebFrameDepictor(java.net.URI namespaceURI,
                                java.lang.String localName)

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, or null if there is no namespace.

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

AbstractWebFrameDepictor

public AbstractWebFrameDepictor(java.net.URI namespaceURI,
                                java.lang.String localName,
                                boolean isEmptyElementAllowed)

Element namespace and local name constructor.

Parameters:

namespaceURI - The URI of the XML namespace of the element, or null if there is no namespace.

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

isEmptyElementAllowed - Whether an empty element can be created if there is no content.

Method Detail

installed

public void installed(C component)

Called when the depictor is installed in a depicted object.

This version listens for property changes of a PropertyBindable object.

This version listens for list changes of a ListListenable object.

If the component is a container, this version listens for container events and marks the view as needing updated.

This implementation listens for changes in the session and in response marks the view as needing updated.

Specified by:

installed in interface Depictor<C extends Frame>

Overrides:

installed in class AbstractComponentDepictor<C extends Frame>

Parameters:

component - The depictedObject into which this depictor is being installed.

See Also:

AbstractDepictor.depictedPropertyChangeListener

uninstalled

public void uninstalled(C component)

Called when the depictor is uninstalled from a depicted object.

This version stop listening for property changes of a PropertyBindable object.

This version stops listening for list changes of a ListListenable object.

If the component is a container, this version stops listening for container events.

This implementation stops listening for session changes.

Specified by:

uninstalled in interface Depictor<C extends Frame>

Overrides:

uninstalled in class AbstractComponentDepictor<C extends Frame>

Parameters:

component - The depicted object from which this depictor is being uninstalled.

See Also:

AbstractDepictor.depictedPropertyChangeListener

depictBody

protected void depictBody()
                   throws java.io.IOException

Depicts the body of the component.

This version depicts the children of the component.

This version increases and decreases the indention level before and after depicting the children, respectively.

This version renders the content of the frame.

Overrides:

depictBody in class AbstractWebComponentDepictor<C extends Frame>

Throws:

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

See Also:

AbstractComponentDepictor.depictChildren()