Package overit.geocall.ux.platform

Class MenuLandingTree

java.lang.Object
overit.geocall.ux.platform.MenuLandingTree
All Implemented Interfaces:
LandingTree
public class MenuLandingTree extends Object implements LandingTree
This class allows you to define landing pages for all menu's pages. Use involves creating a subclass that has a public constructor without parameters, and defines the Lander and any other configurations for the landing.

Here is an example that expose the menu's landing pages


 {@literal @}Geocall.Provider
 public class BasLeandingTree extends MenuLandingTree {
      public BasLeandingTree() {
          super(new Lander());
      }
 }

In order for the pages to be published at the start of the count, you must add the @Geocall.Provider annotation to the sub-class

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected SimpleLander
    lander
     
    protected boolean
    managed
    boolean flag that indicates if the page will be opened inside a geocall frame or is handled by an external container.
    protected String
    modeMenu
    mode of the menu.
    protected String
    wm
    the name that will be assigned to the window manager. if not specified, it will be considered the SimpleLanding.getName()

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    MenuLandingTree()
    Default class's constructor
    protected
    MenuLandingTree(SimpleLander lander)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    final Landing
    getLanding(String name)
    Returns the list of the landings extracted from the menu file
    static Landing
    getLandingFromName(String name)
    Return the landing instance related to the landing name.
    static Landing
    getLandingFromPath(String path)
    Return the landing instance related to the page's path
    String
    getModeMenu()
    Get the menu opening mode.
    String
    getWm()
    Get the name that will be assigned to the window manager on the page open
    boolean
    isManaged()
    returns a boolean flag that indicates if the page will be opened inside a geocall frame or is handled by an external container.
    void
    setManaged(boolean managed)
    boolean flag that indicates if the page will be opened inside a geocall frame or is handled by an external container.
    void
    setModeMenu(String modeMenu)
    Set the menu opening mode.
    void
    setWm(String wm)
    Set the name that will be assigned to the window manager on the page open

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • lander

      protected SimpleLander lander

    • wm

      protected String wm
      the name that will be assigned to the window manager. if not specified, it will be considered the SimpleLanding.getName()

    • modeMenu

      protected String modeMenu
      mode of the menu. Possible values are:
      • on: the menu is visible on the page open but it will be hidden on the mouse leave
      • off: the menu is not visible on the page open but can be open on the mouse over
      • lock: the menu is visible on the page open and it will not disappear on the mouse leave
      • none: the menu is not been present on the page

    • managed

      protected boolean managed
      boolean flag that indicates if the page will be opened inside a geocall frame or is handled by an external container. if the page is managed, it is not registered in the window manager and therefore will not be accessible from the views panel

  • Constructor Details

    • MenuLandingTree

      protected MenuLandingTree(SimpleLander lander)
      Parameters:
      lander - instance of the Lander to use to build the land.

    • MenuLandingTree

      protected MenuLandingTree()
      Default class's constructor

  • Method Details

    • getLandingFromPath

      public static Landing getLandingFromPath(String path)
      Return the landing instance related to the page's path
      Parameters:
      path - the path of the page
      Returns:
      the landing instance related to the page's path or null if there's no registered landing for that path

    • getLandingFromName

      public static Landing getLandingFromName(String name)
      Return the landing instance related to the landing name.
      Parameters:
      name - name defined into the landingName attribute.
      Returns:
      the landing instance related to the name of the page or null if there's no registered landing for that name.

    • getLanding

      public final Landing getLanding(String name)
      Description copied from interface: LandingTree
      Returns the list of the landings extracted from the menu file
      Specified by:
      getLanding in interface LandingTree
      Parameters:
      name - Name
      Returns:
      the list of the landings extracted from the menu file

    • getWm

      public String getWm()
      Description copied from interface: LandingTree
      Get the name that will be assigned to the window manager on the page open
      Specified by:
      getWm in interface LandingTree
      Returns:
      the name that will be assigned to the window manager on the page open. if not specified, it will be considered the Landing.getName()

    • setWm

      public void setWm(String wm)
      Description copied from interface: LandingTree
      Set the name that will be assigned to the window manager on the page open
      Specified by:
      setWm in interface LandingTree
      Parameters:
      wm - the name that will be assigned to the window manager on the page open

    • getModeMenu

      public String getModeMenu()
      Description copied from interface: LandingTree
      Get the menu opening mode.
      Specified by:
      getModeMenu in interface LandingTree
      Returns:
      the menu opening mode. Possible values are:
      • on: the menu is visible on the page open but it will be hidden on the mouse leave
      • off: the menu is not visible on the page open but can be open on the mouse over
      • lock: the menu is visible on the page open and it will not disappear on the mouse leave
      • none: the menu is not been present on the page

    • setModeMenu

      public void setModeMenu(String modeMenu)
      Description copied from interface: LandingTree
      Set the menu opening mode.
      Specified by:
      setModeMenu in interface LandingTree
      Parameters:
      modeMenu - Possible values are:
      • on: the menu is visible on the page open but it will be hidden on the mouse leave
      • off: the menu is not visible on the page open but can be open on the mouse over
      • lock: the menu is visible on the page open and it will not disappear on the mouse leave
      • none: the menu is not been present on the page

    • isManaged

      public boolean isManaged()
      Description copied from interface: LandingTree
      returns a boolean flag that indicates if the page will be opened inside a geocall frame or is handled by an external container. if the page is managed, it is not registered in the window manager and therefore will not be accessible from the views panel
      Specified by:
      isManaged in interface LandingTree
      Returns:
      true if the page will be opened inside a geocall frame; false if it is handled by an external container

    • setManaged

      public void setManaged(boolean managed)
      Description copied from interface: LandingTree
      boolean flag that indicates if the page will be opened inside a geocall frame or is handled by an external container. if the page is managed, it is not registered in the window manager and therefore will not be accessible from the views panel
      Specified by:
      setManaged in interface LandingTree
      Parameters:
      managed - true if the page will be opened inside a geocall frame; false if it is handled by an external container