Package net.ontopia.topicmaps.nav2.plugins

Interface PluginIF

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int ACTIVATED  
      static int DEACTIVATED  
      static int ERROR  

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void addGroup​(String groupId)
      INTERNAL: Add the specified group to groups this plugin belongs to.
      String generateHTML​(ContextTag context)
      INTERNAL: Called by the framework to make the plugin produce the HTML that is going to represent it on a web page in the web application.
      String getDescription()
      INTERNAL: Gets the description of this plugin.
      List getGroups()
      INTERNAL: Returns the groups this plugin belongs to.
      String getId()
      INTERNAL: Returns the ID of this plugin.
      String getParameter​(String name)
      INTERNAL: Returns the value of the parameter.
      String getPluginDirectory()
      INTERNAL: Returns the path to the plugin directory.
      int getState()
      INTERNAL: Returns the state of this plugin.
      String getTarget()
      INTERNAL: Returns the URI frame target of this plugin.
      String getTitle()
      INTERNAL: Returns the title of this plugin.
      String getURI()
      INTERNAL: Returns the URI of this plugin.
      void init()
      INTERNAL: Called by the framework to finalize initialization.
      void resetGroups()
      INTERNAL: Reset all group settings for this plugin.
      void setDescription​(String description)
      INTERNAL: Sets the description of this plugin.
      void setGroups​(List groups)
      INTERNAL: Sets the groups this plugin belongs to.
      void setId​(String id)
      INTERNAL: Sets the ID of this plugin.
      void setParameter​(String name, String value)
      INTERNAL: Called by the framework to give the plugin the value of a configuration parameter.
      void setPluginDirectory​(String path)
      INTERNAL: Called by the framework to give the plugin the directory its plugin.xml file was found in.
      void setState​(int state)
      INTERNAL: Sets the state of this plugin.
      void setTarget​(String target)
      INTERNAL: Sets the URI frame target of this plugin.
      void setTitle​(String title)
      INTERNAL: Sets the title of this plugin.
      void setURI​(String uri)
      INTERNAL: Sets the URI of this plugin.

    • Method Detail

      • generateHTML

        String generateHTML​(ContextTag context)
        INTERNAL: Called by the framework to make the plugin produce the HTML that is going to represent it on a web page in the web application.
        Returns:
        An HTML string to be written into the page. If the returned string is null it means that the plugin does not wish to be displayed on this page.

      • init

        void init()
        INTERNAL: Called by the framework to finalize initialization. Called when there are no more parameters.

      • getId

        String getId()
        INTERNAL: Returns the ID of this plugin.

      • setId

        void setId​(String id)
        INTERNAL: Sets the ID of this plugin.

      • getGroups

        List getGroups()
        INTERNAL: Returns the groups this plugin belongs to. Each group is represented by a string containing the group id.

      • resetGroups

        void resetGroups()
        INTERNAL: Reset all group settings for this plugin. After this operation this plugin will belong to no group.

      • addGroup

        void addGroup​(String groupId)
        INTERNAL: Add the specified group to groups this plugin belongs to.

      • setGroups

        void setGroups​(List groups)
        INTERNAL: Sets the groups this plugin belongs to.

      • getTitle

        String getTitle()
        INTERNAL: Returns the title of this plugin.

      • setTitle

        void setTitle​(String title)
        INTERNAL: Sets the title of this plugin.

      • getDescription

        String getDescription()
        INTERNAL: Gets the description of this plugin.

      • setDescription

        void setDescription​(String description)
        INTERNAL: Sets the description of this plugin.

      • getURI

        String getURI()
        INTERNAL: Returns the URI of this plugin.

      • setURI

        void setURI​(String uri)
        INTERNAL: Sets the URI of this plugin.

        Note: This has not to contain the web application context path.

        Example: plugins/hello/hello.jsp

      • getTarget

        String getTarget()
        INTERNAL: Returns the URI frame target of this plugin.

      • setTarget

        void setTarget​(String target)
        INTERNAL: Sets the URI frame target of this plugin.

      • getState

        int getState()
        INTERNAL: Returns the state of this plugin.

      • setState

        void setState​(int state)
        INTERNAL: Sets the state of this plugin.

      • getParameter

        String getParameter​(String name)
        INTERNAL: Returns the value of the parameter.

      • setParameter

        void setParameter​(String name,
                  String value)
        INTERNAL: Called by the framework to give the plugin the value of a configuration parameter.

      • getPluginDirectory

        String getPluginDirectory()
        INTERNAL: Returns the path to the plugin directory. This is the path in the file system the server is running in, if the web application is deployed as an unexploded WAR.

      • setPluginDirectory

        void setPluginDirectory​(String path)
        INTERNAL: Called by the framework to give the plugin the directory its plugin.xml file was found in. This is useful for plugins which wish to use other files found in the same directory.