Package io.guise.framework.platform.web

Class WebFrameDepictor<C extends Frame>

  • 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

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

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

        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 depicted object from which this depictor is being uninstalled.
        See Also:
        AbstractDepictor.depictedPropertyChangeListener

      • depictBegin

        protected void depictBegin()
                    throws java.io.IOException
        Description copied from class: AbstractWebComponentDepictor
        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.

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

      • depictEnd

        public void depictEnd()
               throws java.io.IOException
        Ends the depiction process.

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

        This version closes the decorator elements.

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