com.guiseframework.platform.web
Class WebApplicationFrameDepictor<C extends ApplicationFrame>

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

Type Parameters:

C - The type of component being depicted.

All Implemented Interfaces:

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

public class WebApplicationFrameDepictor<C extends ApplicationFrame>
extends AbstractWebFrameDepictor<C>

Strategy for rendering an application frame as a series of XHTML elements. This class generates XHTML in the form: <xhtml:html><xhtml:body><xhtml:form>[<xhtml:div>]

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

protected static java.lang.String	ACTION_INPUT_ID_SEGMENT The ID segment for the hidden action input field.
protected static java.lang.String	BUSY_ID_SEGMENT The ID segment for the busy information.
protected static java.lang.String	FLYOVER_IFRAME_ID_SEGMENT The ID segment for the flyover IFrame used with IE6.
protected static java.lang.String	FORM_ID_SEGMENT The ID segment for the form.
protected static java.lang.String	GUISE_FLASH_ID The ID for the Guise SWF.
protected static java.lang.String	INIT_IFRAME_ID_SEGMENT The ID segment for the layer to shield user input during initialization.
protected static java.lang.String	MODAL_IFRAME_ID_SEGMENT The ID segment for the model IFrame used with IE6.

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

WebApplicationFrameDepictor()
Default constructor using the XHTML body element.

Method Summary

protected void	depictBegin() Begins the rendering process.
protected void	depictEnd() Ends the rendering process.
static java.lang.String	getActionInputID(ApplicationFrame applicationFrame) Determines the ID to be used for the hidden field associated with the given application frame.
static java.lang.String	getBusyID(ApplicationFrame applicationFrame) Determines the ID to be used for an element containing busy component information.
static java.lang.String	getFlyoverIFrameID(ApplicationFrame applicationFrame) Determines the ID to be used for an IFrame used for a flyover shield in IE6.
static java.lang.String	getFormID(ApplicationFrame applicationFrame) Determines the ID to be used for a form associated with the given application frame.
static java.lang.String	getInitIFrameID(ApplicationFrame applicationFrame) Determines the ID to be used for an IFrame used for shielding the UI from user input during initialization.
static java.lang.String	getModalIFrameID(ApplicationFrame applicationFrame) Determines the ID to be used for an IFrame used for a modal shield in IE6.
protected static boolean	hasResourceImportControl(Component component) Determines whether the given component or any of its children contains a resource import control (a control with a resource import value model).

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

depictBody, installed, uninstalled

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

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

Field Detail

ACTION_INPUT_ID_SEGMENT

protected static final java.lang.String ACTION_INPUT_ID_SEGMENT

The ID segment for the hidden action input field.

See Also:

Constant Field Values

BUSY_ID_SEGMENT

protected static final java.lang.String BUSY_ID_SEGMENT

The ID segment for the busy information.

See Also:

Constant Field Values

FLYOVER_IFRAME_ID_SEGMENT

protected static final java.lang.String FLYOVER_IFRAME_ID_SEGMENT

The ID segment for the flyover IFrame used with IE6.

See Also:

Constant Field Values

FORM_ID_SEGMENT

protected static final java.lang.String FORM_ID_SEGMENT

The ID segment for the form.

See Also:

Constant Field Values

INIT_IFRAME_ID_SEGMENT

protected static final java.lang.String INIT_IFRAME_ID_SEGMENT

The ID segment for the layer to shield user input during initialization.

See Also:

Constant Field Values

MODAL_IFRAME_ID_SEGMENT

protected static final java.lang.String MODAL_IFRAME_ID_SEGMENT

The ID segment for the model IFrame used with IE6.

See Also:

Constant Field Values

GUISE_FLASH_ID

protected static final java.lang.String GUISE_FLASH_ID

The ID for the Guise SWF.

See Also:

Constant Field Values

Constructor Detail

WebApplicationFrameDepictor

public WebApplicationFrameDepictor()

Default constructor using the XHTML body element.

Method Detail

getActionInputID

public static java.lang.String getActionInputID(ApplicationFrame applicationFrame)

Determines the ID to be used for the hidden field associated with the given application frame.

Parameters:

applicationFrame - The frame for which an input ID should be returned.

Returns:

The ID of the hidden field that holds any action value.

getBusyID

public static java.lang.String getBusyID(ApplicationFrame applicationFrame)

Determines the ID to be used for an element containing busy component information.

Parameters:

applicationFrame - The frame for which a busy ID should be returned.

Returns:

An ID appropriate for creating an element to contain busy component information.

getFlyoverIFrameID

public static java.lang.String getFlyoverIFrameID(ApplicationFrame applicationFrame)

Determines the ID to be used for an IFrame used for a flyover shield in IE6.

Parameters:

applicationFrame - The frame for which a flyover IFrame ID should be returned.

Returns:

An ID appropriate for creating a flyover IFrame for IE6.

getFormID

public static java.lang.String getFormID(ApplicationFrame applicationFrame)

Determines the ID to be used for a form associated with the given application frame.

Parameters:

applicationFrame - The frame for which a form ID should be returned.

Returns:

An ID appropriate for creating a form in the given frame.

getInitIFrameID

public static java.lang.String getInitIFrameID(ApplicationFrame applicationFrame)

Determines the ID to be used for an IFrame used for shielding the UI from user input during initialization.

Parameters:

applicationFrame - The frame for which an init IFrame ID should be returned.

Returns:

An ID appropriate for creating an init IFrame.

getModalIFrameID

public static java.lang.String getModalIFrameID(ApplicationFrame applicationFrame)

Determines the ID to be used for an IFrame used for a modal shield in IE6.

Parameters:

applicationFrame - The frame for which a modal IFrame ID should be returned.

Returns:

An ID appropriate for creating a modal IFrame for IE6.

depictBegin

protected void depictBegin()
                    throws java.io.IOException

Begins the rendering process. This version renders an outer html element.

Overrides:

depictBegin in class AbstractWebComponentDepictor<C extends ApplicationFrame>

Throws:

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

depictEnd

protected void depictEnd()
                  throws java.io.IOException

Ends the rendering process. This version ends the outer html element and the inner form element.

Overrides:

depictEnd in class AbstractWebComponentDepictor<C extends ApplicationFrame>

Throws:

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

hasResourceImportControl

protected static boolean hasResourceImportControl(Component component)

Determines whether the given component or any of its children contains a resource import control (a control with a resource import value model).

Parameters:

component - The component to check for a resource input value model.

Returns:

true if the component or any of its children contain a resource import control.

See Also:

ValueControl, ValueModel, ResourceImport