com.guiseframework.platform.web
Class WebFrameDepictor<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>
                  com.guiseframework.platform.web.WebFrameDepictor<C>

Type Parameters:

C - The type of component being depicted.

All Implemented Interfaces:

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

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

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.

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

WebFrameDepictor()
Default constructor using the XHTML <div> element.

Method Summary

protected void	depictBegin() Begins the rendering process.
void	depictEnd() Ends the rendering process.
protected java.util.Map<java.lang.String,java.lang.Object>	getOuterStyles() Retrieves the styles for the outer element 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.AbstractWebFrameDepictor

depictBody

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

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

WebFrameDepictor

public WebFrameDepictor()

Default constructor using the XHTML <div> element.

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 AbstractWebFrameDepictor<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 AbstractWebFrameDepictor<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()

getOuterStyles

protected java.util.Map<java.lang.String,java.lang.Object> getOuterStyles()

Retrieves the styles for the outer element of the component. This version combines the body styles with the outer styles.

Overrides:

getOuterStyles in class AbstractWebComponentDepictor<C extends Frame>

Returns:

The styles for the outer element of the component, mapped to CSS property names.

See Also:

AbstractWebComponentDepictor.getBodyStyles()

depictBegin

protected void depictBegin()
                    throws java.io.IOException

Begins the rendering process.

Overrides:

depictBegin in class AbstractWebComponentDepictor<C extends Frame>

Throws:

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

depictEnd

public void depictEnd()
               throws java.io.IOException

Ends the rendering process. This version closes the decorator elements.

Overrides:

depictEnd in class AbstractWebComponentDepictor<C extends Frame>

Throws:

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