Package overit.geocall.basic.ui.control

Class TaskBox

java.lang.Object
overit.geocall.platform.ui.UINode
overit.geocall.ui.Component
overit.geocall.ui.Control
overit.geocall.basic.ui.control.TaskBox
All Implemented Interfaces:
Serializable, overit.geocall.marks.MethodExposer, overit.geocall.marks.NameExposer, AjaxableComponent, Badgeable, Hideable, Identified, Tool, overit.geocall.ux.configurability.UIConfigurable, overit.geocall.ux.edm.ModelConfigurable
Direct Known Subclasses:
TaskBoxMenu
@Component public class TaskBox extends Control implements Hideable, AjaxableComponent
This class defines the component to be inserted inside the TaskBar, which is used to group several menu items (TaskMessage) belonging to a specific sub-category, or a particular logical grouping.
Each box can be visible or not, even according to the user (and his privileges) currently logged in the application and can be minimized to reduce the space occupied and in this way make the menu shorter and more easily usable
See Also:
GCApi:
component

  • Field Details

  • Constructor Details

  • Method Details

    • setVISIBLE

      public void setVISIBLE(String s)
      Defines if the TaskBox should be visible or not
      Specified by:
      setVISIBLE in interface Hideable
      Parameters:
      s - A string that represents a boolean value ("true" or "1", "false" or "0") or a function.
      If the string is not recognized as a boolean value, it is considered as a user function with this meaning: if the user currently logged in the application has the function, the box and all its content will be rendered, otherwise it will not

    • isVisible

      public boolean isVisible()
      Checks if the TaskBox is rendered for the user currently logged in the application, or not (see getBoolean(visible,id,true))
      Specified by:
      isVisible in interface Hideable
      Returns:
      true if the box is visible, false otherwise

    • setOPEN

      public void setOPEN(String s)
      Defines the opening status of the TaskBox, ie if the box is minimized or not
      Parameters:
      s - A string that represents a boolean value ("true" or "1", "false" or "0").
      If the string is not recognized as a boolean value, it will be used the default value, that is true

    • getOPEN

      public boolean getOPEN()
      Returns the opening status of the TaskBox
      Returns:
      true if the TaskBox is opened, false otherwise

    • getHtml

      public org.apache.ecs.Element getHtml(EntitySet es)
      Description copied from class: Component
      Abstract method that must be extended and returns the html code of the Component
      Specified by:
      getHtml in class Component
      Parameters:
      es - The EntitySet to which the element belongs
      Returns:
      The html of the Component

    • 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

    • getFrameHtml

      public org.apache.ecs.Element getFrameHtml(overit.geocall.ux.servlet.processor.Change change, 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:
      change - 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

    • draw

      public final org.apache.ecs.Element draw(EntitySet es, boolean open, String name, String id, String keylabel, String shortcut, ArrayList elements, Control control)
      Returns the html box element
      Parameters:
      es - The EntitySet to which the element belongs
      open - The opening status of the box
      name - The name that defines the box
      id - The id
      keylabel - The label that appear in the header
      shortcut - The shortcut key for the label
      elements - The ArrayList of the child elements
      control - The box itself
      Returns:
      The html element of the box component

    • draw

      public final org.apache.ecs.Element draw(EntitySet es, boolean open, String name, String id, String keylabel, String shortcut, ArrayList elements, Control control, String menuLevelPosition, boolean isDrawingLeafItem)
      Returns the html box element
      Parameters:
      es - The EntitySet to which the element belongs
      open - The opening status of the box
      name - The name that defines the box
      id - The id
      keylabel - The label that appear in the header
      shortcut - The shortcut key for the label
      elements - The ArrayList of the child elements
      control - The box itself
      menuLevelPosition - The position of the menu level from which the edit event it's called.
      isDrawingLeafItem - Defines whether a leaf node is being drawn or not
      Returns:
      The html element of the box component