com.guiseframework.platform.web
Class AbstractWebFrameDepictor<C extends Frame>

java.lang.Object
  com.guiseframework.platform.AbstractDepictor<C>
      com.guiseframework.platform.AbstractComponentDepictor<C>
          com.guiseframework.platform.web.AbstractWebComponentDepictor<C>
              com.guiseframework.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 com.guiseframework.platform.AbstractComponentDepictor

AbstractComponentDepictor.DepictedCompositeComponentListener

Nested classes/interfaces inherited from class com.guiseframework.platform.AbstractDepictor

AbstractDepictor.DepictedPropertyChangeListener

Field Summary

Fields inherited from class com.guiseframework.platform.web.AbstractWebComponentDepictor

BODY_END_PATTERN, BODY_START_PATTERN

Fields inherited from class com.guiseframework.platform.AbstractComponentDepictor

childPropertyChangeListener

Fields inherited from interface com.guiseframework.platform.Depictor

GENERAL_PROPERTY

Constructor Summary

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

protected void	depictBody() Renders the body of the component.
void	installed(C component) Called when the depictor is installed in a component.
void	uninstalled(C component) Called when the depictor is uninstalled from a component.

Methods inherited from class com.guiseframework.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 com.guiseframework.platform.AbstractComponentDepictor

depictChild, depictChildren, depictedObjectPropertyChange, getDepictedCompositeComponentListener, getErrorMessage, processEvent

Methods inherited from class com.guiseframework.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 com.guiseframework.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 component. 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 component into which this view is being installed.

Throws:

java.lang.NullPointerException - if the given component is null.

java.lang.IllegalStateException - if this view is already installed in a component.

See Also:

AbstractDepictor.getDepictedPropertyChangeListener()

uninstalled

public void uninstalled(C component)

Called when the depictor is uninstalled from a component. 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 component from which this view is being uninstalled.

Throws:

java.lang.NullPointerException - if the given component is null.

java.lang.IllegalStateException - if this view is not installed in a component.

See Also:

AbstractDepictor.getDepictedPropertyChangeListener()

depictBody

protected void depictBody()
                   throws java.io.IOException

Renders the body of the component. 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 rendering the component.

See Also:

ContentComponent.getContent()