Package overit.geocall.ui

Class UIMenu

java.lang.Object
overit.geocall.ui.UIMenu
All Implemented Interfaces:
Serializable
public class UIMenu extends Object implements Serializable
This class imlements Serializable.
This class implements and defines the User interface Menù, used to navigate through the different pages.
See Also:

  • Field Details

    • _barType

      protected String _barType

    • _barMode

      protected String _barMode

    • _barLayout

      protected String _barLayout

    • _xmlt

      protected XMLTree _xmlt

    • _position

      protected String _position

    • _selected

      protected String _selected

    • _off

      protected boolean _off

  • Constructor Details

    • UIMenu

      public UIMenu(XMLTree xmlt, String barType, String barMode)
      Creates a new instance of UIMenu
      Parameters:
      xmlt - The XMLTree that defines the global menu of the application
      barType - The string that represents the bar type. The possible values are: 'client' and 'floating'
      barMode - A string that represents the floating state of the bar. The possible values are: 'lock' (not floating), 'on' (floating and visible in the screen), 'off' (floating but not currently visible in the screen)

    • UIMenu

      public UIMenu(XMLTree xmlt, String barType, String barMode, String barLayout)
      Creates a new instance of UIMenu
      Parameters:
      xmlt - The XMLTree that defines the global menu of the application
      barType - The string that represents the bar type. The possible values are: 'client' and 'floating'
      barMode - A string that represents the floating state of the taskbar. The possible values are: 'lock' (not floating), 'on' (floating and visible in the screen), 'off' (floating but not currently visible in the screen)
      barLayout - A string that represents the scroll modality of the bar (only for the client bar). The possible values are: 'fullScroll' (the scrollbar allows the scrolling of the entiry bar), 'fixedIdentity' (this is the default value, the scrollbar allows the scrolling of the menu voices, instead the logos and user information remain fixed), 'fixedLogo' (the scrollbar allows the scrolling of the menu voices and of the user information, instead the logos remain fixed) and 'foldableFavorites' that is the same as fixedIdentity with the feature for hide/shows the favorites box in addition.

  • Method Details

    • getPosition

      public String getPosition()
      Returns the position in the hierarchy
      Returns:
      A string that defines the position

    • getSelected

      public String getSelected()
      Returns the selected voice of the menu
      Returns:
      A string that defines the selected voice

    • getXMLTree

      public XMLTree getXMLTree()
      Returns the XMLTree that defines the menu voices and structure
      Returns:
      The tree that defines the menu

    • setSelected

      public void setSelected(String selected)
      Sets the selected voice of the menu
      Parameters:
      selected - A string that defines the selected voice

    • setPosition

      public void setPosition(String position)
      Sets the position in the hierarchy
      Parameters:
      position - A string that defines the position

    • setSelected

      public void setSelected(String selected, boolean adjustPosition)
      Sets the selected voice and eventually corrects the position in the hierarchy
      Parameters:
      selected - A string that defines the selected voice
      adjustPosition - true to adjust the position, false otherwise

    • indexer

      public static void indexer(XMLTree x, String path)

    • indexer

      public static void indexer(XMLTree x, String path, List<XMLTree> favoritesNodes)

    • getBarType

      public String getBarType()
      Returns the type of the bar for the user currently logged in the application
      Returns:
      The string that represents the bar type. The possible values are: 'client' or 'floating'

    • getBarMode

      public String getBarMode()
      Returns the floating state of the bar
      Returns:
      A string that represents the floating state of the menu bar. The possible values are: 'lock' (not floating), 'on' (floating and visible in the screen), 'off' (floating but not currently visible in the screen)

    • setBarMode

      public void setBarMode(String mode)
      Sets the floating state of the bar
      Parameters:
      mode - A string that represents the floating state of the bar. The possible values are: 'lock' (not floating), 'on' (floating and visible in the screen), 'off' (floating but not currently visible in the screen)

    • getBarLayout

      public String getBarLayout()
      Returns the scroll modality of the bar
      Returns:
      A string that represents the scroll modality of the bar (only for the client bar). The possible values are: 'fullScroll' (the scrollbar allows the scrolling of the entiry bar), 'fixedIdentity' (this is the default value, the scrollbar allows the scrolling of the menu voices, instead the logos and user information remain fixed), 'fixedLogo' (the scrollbar allows the scrolling of the menu voices and of the user information, instead the logos remain fixed) and 'foldableFavorites' that is the same as fixedIdentity with the feature for hide/shows the favorites box in addition.

    • setBarLayout

      public void setBarLayout(String layout)
      Sets the scroll modality of the bar
      Parameters:
      layout - A string that represents the scroll modality of the bar (only for the client bar). The possible values are: 'fullScroll' (the scrollbar allows the scrolling of the entiry bar), 'fixedIdentity' (this is the default value, the scrollbar allows the scrolling of the menu voices, instead the logos and user information remain fixed), 'fixedLogo' (the scrollbar allows the scrolling of the menu voices and of the user information, instead the logos remain fixed) and 'foldableFavorites' that is the same as fixedIdentity with the feature for hide/shows the favorites box in addition.