Package io.guise.framework.platform.web

Class WebLinkDepictor<C extends ActionControl>

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.AbstractSimpleWebComponentDepictor<C>
io.guise.framework.platform.web.AbstractWebActionControlDepictor<C>
io.guise.framework.platform.web.WebLinkDepictor<C>
Type Parameters:
C - The type of component being depicted.
All Implemented Interfaces:
ComponentDepictor<C>, Depictor<C>, WebComponentDepictor<C>, WebDepictor<C>
Direct Known Subclasses:
WebHeadingLinkDepictor, WebImageActionControlDepictor, WebSelectLinkDepictor
public class WebLinkDepictor<C extends ActionControl> extends AbstractWebActionControlDepictor<C>
Strategy for rendering an action model control as an XHTML <a> element. If a link has a NavigateActionListener as one of its action listeners, the generated href URI will be that of the listener, and a target attribute will be set of the listener specifies a viewport ID.
Author:
Garret Wilson

  • Constructor Details

    • WebLinkDepictor

      public WebLinkDepictor()
      Default constructor using the XHTML <a> element.

  • Method Details

    • 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 writes the body ID and class attributes, along with the direction attribute.

      This version renders any component info as a link title.

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

    • getNavigateActionListener

      public static AbstractNavigateActionListener getNavigateActionListener(ActionControl actionControl)
      Retrieves the first NavigateActionListener or ModalNavigationListener registered with the given action control, if any. This action listener is useful for determining whether predetermined navigation action is called for. If more than one navigate action listener is registered with the given action control, it is undefined which will be returned.
      Parameters:
      actionControl - The action control used to look for the registered listener.
      Returns:
      An action listener registered with the action control with predefined semantics for navigation, or null if no such action listener is registered with the control.

    • depictBody

      protected void depictBody() throws IOException
      Depicts the body of the component.

      This version depicts the children of the component.

      This version increases and decreases the indention level before and after depicting the children, respectively.

      This version renders any label information.

      Overrides:
      depictBody in class AbstractWebComponentDepictor<C extends ActionControl>
      Throws:
      IOException - if there is an error updating the depiction.
      See Also:

    • writeSupplementaryIcons

      protected void writeSupplementaryIcons() throws IOException
      Writes the supplementary icons. If no supplementary icons are present, no action occurs. This version does nothing.
      Throws:
      IOException - if there is an error writing the icons.