Package overit.geocall.basic.ui.container

Class ServerMultiForm

java.lang.Object
overit.geocall.platform.ui.UINode
overit.geocall.ui.Component
overit.geocall.ui.Control
overit.geocall.basic.ui.container.ServerMultiForm
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:
SingleForm
@Component public class ServerMultiForm extends Control implements AjaxableComponent, Hideable
The class extends Control and implements the user interface element that allows to contain and render one or more child components, that are mainly forms Form, and show them in a multi-tabbed structure.
This element must be used even if it contains only one child, because it provides the correct user interface (like for example the right background color).
See Also:
GCApi:
component

  • Field Details

    • _fullsize

      protected boolean _fullsize

    • _visiblename

      protected String _visiblename

    • _load

      protected String _load

    • _loadpos

      protected int _loadpos

    • _visible

      protected SetPredicate _visible

    • _bgcolor

      protected String _bgcolor

    • _closable

      protected boolean _closable

    • _ajax

      protected boolean _ajax

    • _conf

      protected State.Conf _conf

    • TABS_WIDGET_STATE_CLASS

      public static final String TABS_WIDGET_STATE_CLASS
      See Also:

    • editable

      protected boolean editable

  • Constructor Details

    • ServerMultiForm

      public ServerMultiForm()

  • Method Details

    • setBGCOLOR

      public void setBGCOLOR(String s)
      Sets a custom the background color for the ServerMultiForm
      Parameters:
      s - A string that contains the desired color, the value must be compliant to css color rules

    • setFULLSIZE

      public void setFULLSIZE(String s)
      Indicates if the ServerMultiForm has to occupy all the available space in width
      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 false

    • setVISIBLE

      public void setVISIBLE(String s)
      Defines if the ServerMultiForm should be rendered or not
      Specified by:
      setVISIBLE in interface Hideable
      Parameters:
      s - A string that represent 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 element will be rendered, otherwise it will not

    • isVisible

      public boolean isVisible()
      Checks if the ServerMultiForm 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 element is visible, false otherwise

    • setLOAD

      public void setLOAD(String s)
      Sets the name of the child element - the tab - that must be loaded when is opened the page that contains the ServerMultiForm
      Parameters:
      s - The string that contains the name of the element that must be loaded

    • setLOADPOS

      public void setLOADPOS(String s)
      Sets the position of the child element - the tab - that must be loaded when is opened the page that contains the ServerMultiForm
      Parameters:
      s - The position of the element that must be loaded

    • setCLOSABLE

      public void setCLOSABLE(String s)
      Defines if the ServerMultiForm is closable, i.e. if an additional tab will appear, tab that will allow you to close all the tabs and minimize the vertical space occupied by the ServerMultiForm
      Parameters:
      s - A string that represent 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 false

    • setAJAX

      public void setAJAX(String s)
      Activates or deactivates the ajax interactions
      Parameters:
      s - A string that represent a boolean value ("true" or "1" to activate, "false" or "0" to deactivate).
      If the string is not recognized as a boolean value, it will be used the default value, that is true

    • setEDITABLE

      public void setEDITABLE(String s)
      Sets if the component is editable or not. If it is editable hovering the upper right corner of the component, the edit icon will be shown and clicking it will be possible to show the configurability panel.
      Parameters:
      s - true or false

    • isEditable

      public boolean isEditable()
      Gets if the component is editable or not. If it is editable hovering the upper right corner of the component, the edit icon will be shown and clicking it will be possible to show the configurability panel.
      Returns:
      true if it is editable, false otherwise

    • setup

      public void setup()
      Description copied from class: Component
      Setup the Component
      Overrides:
      setup in class Component

    • onSwitch

      @Deprecated(since="9.0", forRemoval=true) public boolean onSwitch(Object o)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use onSwitch(UIMessage)
      Parameters:
      o - Use onSwitch(UIMessage)
      Returns:
      Use onSwitch(UIMessage)

    • onSwitch

      public boolean onSwitch(UIMessage uim)
      Fired when the user click on a closed tab to switch from a tab to another
      Parameters:
      uim - The UIMessage with the parameters
      Returns:
      false

    • doSwitch

      protected boolean doSwitch(String load, String name, UIMessage uim)

    • getFrameHtml

      public org.apache.ecs.Element getFrameHtml(overit.geocall.ux.servlet.processor.Change change, EntitySet es)
      Defines the html part of the ServerMultiForm that changes when an Ajax interaction occurs.
      Implements the AjaxableComponent interface.
      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

    • getTab

      public static org.apache.ecs.html.Div getTab(boolean on, boolean enabled, Icon icon, String label, String title, String shortcut, String background)

    • publishedComponent

      protected Component publishedComponent()

    • getPublishedChildrenList

      public List getPublishedChildrenList()
      Description copied from class: Component
      Returns the published childs. Those that are not published are not even searched to be synchronized via Ajax
      Overrides:
      getPublishedChildrenList in class Component
      Returns:
      The List of published childs

    • 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

    • buildDisplayScript

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

    • getHtml

      public org.apache.ecs.Element getHtml(EntitySet es)
      Returns the html code of the table
      Specified by:
      getHtml in class Component
      Parameters:
      es - The EntitySet to which the element belongs
      Returns:
      The html code of the table

    • changed

      public void changed(overit.geocall.ux.servlet.processor.Change change)
      Defines the morphing of the ServerMultiForm that occurs when there is an Ajax interaction
      Implements the AjaxableComponent interface.
      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()
      Defines the default Change object for the table.
      Implements the AjaxableComponent interface.
      Specified by:
      getDefaultChange in interface AjaxableComponent
      Returns:
      The default Change object that defines the default morphing type of the ServerMultiForm

    • reload

      public void reload()

    • onShowConfigurabilityPanel

      public boolean onShowConfigurabilityPanel(UIMessage uim)

    • getConfigChildren

      public Set<Component> getConfigChildren()