Package io.guise.framework.platform.web

Class WebApplicationFrameDepictor<C extends ApplicationFrame>

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>
io.guise.framework.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

  • Field Details

    • ACTION_INPUT_ID_SEGMENT

      protected static final String ACTION_INPUT_ID_SEGMENT
      The ID segment for the hidden action input field.
      See Also:

    • BUSY_ID_SEGMENT

      protected static final String BUSY_ID_SEGMENT
      The ID segment for the busy information.
      See Also:

    • FORM_ID_SEGMENT

      protected static final String FORM_ID_SEGMENT
      The ID segment for the form.
      See Also:

    • INIT_IFRAME_ID_SEGMENT

      protected static final String INIT_IFRAME_ID_SEGMENT
      The ID segment for the layer to shield user input during initialization.
      See Also:

    • GUISE_FLASH_ID

      protected static final String GUISE_FLASH_ID
      The ID for the Guise SWF.
      See Also:

  • Constructor Details

    • WebApplicationFrameDepictor

      public WebApplicationFrameDepictor()
      Default constructor using the XHTML body element.

  • Method Details

    • getActionInputID

      public static 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 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.

    • getFormID

      public static 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 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.

    • depictBegin

      protected void depictBegin() throws IOException
      Begins the depiction process.

      This version renders the beginning XML element information, if there is any, leaving the beginning tag open for attributes.

      This version writes common XHTML attributes.

      This version renders an outer html element.

      Overrides:
      depictBegin in class AbstractWebComponentDepictor<C extends ApplicationFrame>
      Throws:
      IOException - if there is an error updating the depiction.

    • depictEnd

      protected void depictEnd() throws IOException
      Description copied from class: AbstractWebComponentDepictor
      Ends the depiction process.

      This version renders the ending XML element information, if there is any.

      Overrides:
      depictEnd in class AbstractWebComponentDepictor<C extends ApplicationFrame>
      Throws:
      IOException - if there is an error updating the depiction.

    • 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: