Package overit.geocall.platform

Interface Landing

All Superinterfaces:
Cloneable
All Known Implementing Classes:
SimpleLanding
public interface Landing extends Cloneable

  • Method Summary

    Modifier and Type
    Method
    Description
    Landing
    clone(String params)
    Create a new clone instance of Landing and the parameter is set as params value of the copy instance.
    Getter
    getDefinition()
    Get the definition of the Landing.
    List<String>
    getFunctions()
    returns the list of functions required to access the landing page
    Lander<?>
    getLander()
    Get the instance of the Lander.
    String
    getModeMenu()
    Get the menu opening mode.
    String
    getName()
    Get the unique name of the Landing
    String
    getPage()
    Get the path of the page to open
    String
    getParams()
    Get the parameters of the Landing
    String
    getPosMenu()
    Get the string indicating the page's position inside the menu.
    String
    getStaticParams()
    Get the static parameters of the Landing.
    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
    setFunction(List<String> functions)
    Sets the list of functions required to access the landing page
    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
    setName(String name)
    Set the unique name of the Landing
    void
    setPage(String page)
     
    void
    setParams(String params)
    Set the parameters of the Landing passed in the URI after the landing name.
    void
    setPosMenu(String posMenu)
     
    void
    setStaticParams(String staticParams)
    Set the static parameters of the Landing defined inside the param attribute of the landing configuration.
    void
    setWm(String wm)
    Set the name that will be assigned to the window manager on the page open

  • Method Details

    • clone

      Landing clone(String params)
      Create a new clone instance of Landing and the parameter is set as params value of the copy instance.
      Parameters:
      params - The value of params variable of the clone instance
      Returns:
      The cloned instance of Landing

    • getName

      String getName()
      Get the unique name of the Landing
      Returns:
      The name of the Landing

    • setName

      void setName(String name)
      Set the unique name of the Landing
      Parameters:
      name - The name of the Landing

    • getWm

      String getWm()
      Get the name that will be assigned to the window manager on the page open
      Returns:
      the name that will be assigned to the window manager on the page open. if not specified, it will be considered the getName()

    • setWm

      void setWm(String wm)
      Set the name that will be assigned to the window manager on the page open
      Parameters:
      wm - the name that will be assigned to the window manager on the page open

    • getLander

      Lander<?> getLander()
      Get the instance of the Lander.
      Returns:
      The instance of the Landing builder.

    • getParams

      String getParams()
      Get the parameters of the Landing
      Returns:
      The string passed in the URI after the landing name.

    • setParams

      void setParams(String params)
      Set the parameters of the Landing passed in the URI after the landing name.
      Parameters:
      params - The string passed in the URI after the landing name.

    • getDefinition

      Getter getDefinition()
      Get the definition of the Landing.
      Returns:
      The Getter containing all the attributes expressed in the XML.

    • getStaticParams

      String getStaticParams()
      Get the static parameters of the Landing.
      Returns:
      the string defined inside the param attribute of the landing configuration

    • setStaticParams

      void setStaticParams(String staticParams)
      Set the static parameters of the Landing defined inside the param attribute of the landing configuration.
      Parameters:
      staticParams - the string defined inside the param attribute of the landing configuration

    • getModeMenu

      String getModeMenu()
      Get the menu opening mode.
      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

      void setModeMenu(String modeMenu)
      Set the menu opening mode.
      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

    • getPosMenu

      String getPosMenu()
      Get the string indicating the page's position inside the menu.
      Returns:
      the page's position inside the menu

    • setPosMenu

      void setPosMenu(String posMenu)

    • getPage

      String getPage()
      Get the path of the page to open
      Returns:
      the path of the page to open

    • setPage

      void setPage(String page)

    • isManaged

      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. if the page is managed, it is not registered in the window manager and therefore will not be accessible from the views panel
      Returns:
      true if the page will be opened inside a geocall frame; false if it is handled by an external container

    • setManaged

      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. if the page is managed, it is not registered in the window manager and therefore will not be accessible from the views panel
      Parameters:
      managed - true if the page will be opened inside a geocall frame; false if it is handled by an external container

    • setFunction

      void setFunction(List<String> functions)
      Sets the list of functions required to access the landing page
      Parameters:
      functions - the list of functions required to access the landing page

    • getFunctions

      List<String> getFunctions()
      returns the list of functions required to access the landing page
      Returns:
      the list of functions required to access the landing page