Package overit.geocall.basic.ui.control

Class DockBar

java.lang.Object
overit.geocall.platform.ui.UINode
overit.geocall.ui.Component
overit.geocall.ui.Control
overit.geocall.basic.ui.Container
overit.geocall.basic.ui.control.DockBar
All Implemented Interfaces:
Serializable, overit.geocall.marks.MethodExposer, overit.geocall.marks.NameExposer, AjaxableComponent, Badgeable, Identified, Tool, overit.geocall.ux.configurability.UIConfigurable, overit.geocall.ux.edm.ModelConfigurable
@Component public class DockBar extends Container implements AjaxableComponent
This class, that extends Container, implements a graphic interface object that is not visible, but serves as a container for other objects, and is positioned on one side of the window and remains attached to it even after resizing.
It is usually used to correctly position the handlers that allow the opening of side panels or panel that appears from top / bottom.

This is an example of use:

<DockBar position="b">
  <PlainButton submit="1" name="Hide#" icon="pullbottom" iconcss="edit" />
</DockBar>

See Also:
GCApi:
component

  • Field Details

    • _position

      protected String _position

  • Constructor Details

    • DockBar

      public DockBar()

  • Method Details

    • setTYPE

      public void setTYPE(String type)
      Deprecated.
      Use setPOSITION(java.lang.String)
      Parameters:
      type - Use setPOSITION(java.lang.String)

    • setPOSITION

      public void setPOSITION(String position)
      Defines the position of the DockBar
      Parameters:
      position - Possible values are:
      "l" to position the dockbar to the left;
      "r" to position the dockbar to the right;
      "t" to position the tockbar to the top;
      "b" to position the dockbar to the bottom

    • getHtml

      public org.apache.ecs.Element getHtml(EntitySet es)
      Description copied from class: Container
      Returns the html code of the Container
      Overrides:
      getHtml in class Container
      Parameters:
      es - The EntitySet to which the element belong
      Returns:
      The html code of the Container

    • getFrameHtml

      public org.apache.ecs.Element getFrameHtml(overit.geocall.ux.servlet.processor.Change c, EntitySet es)
      Description copied from interface: AjaxableComponent
      Defines the html part of the element that changes when an Ajax interaction occurs
      Specified by:
      getFrameHtml in interface AjaxableComponent
      Parameters:
      c - The Change object that defines the specific morphing type for the element
      es - The EntitySet to which the element belongs
      Returns:
      The html part of the element that changes when an Ajax interaction occurs

    • buildSetupScript

      public void buildSetupScript(StringBuilder sb)
      Description copied from class: Component
      Every component can add a script to the StringBuilder, script executed when the component is created.
      Overrides:
      buildSetupScript in class Component
      Parameters:
      sb - The StringBuilder on which we want to add the script

    • changed

      public void changed(overit.geocall.ux.servlet.processor.Change change)
      Description copied from interface: AjaxableComponent
      Defines the morphing of the element that occurs when there is an Ajax interaction
      Specified by:
      changed in interface AjaxableComponent
      Parameters:
      change - The Change object that defines the specific morphing type for the element

    • getDefaultChange

      public overit.geocall.ux.servlet.processor.Change getDefaultChange()
      Description copied from interface: AjaxableComponent
      Defines the default Change object for the element
      Specified by:
      getDefaultChange in interface AjaxableComponent
      Returns:
      The default Change object that defines the default morphing type of the element