Module tvbrowser

Interface PluginProxy

    • Method Detail

      • isActivated

        boolean isActivated()
        Gets whether the plugin is currently activated.
        Returns:
        whether the plugin is currently activated.
      • getSettingsTab

        SettingsTabProxy getSettingsTab()
        Gets the SettingsTab object, which is added to the settings-window.
        Returns:
        the SettingsTab object or null if the plugin does not provide this feature.
      • getButtonAction

        ActionMenu getButtonAction()
        Gets the action to use for the main menu and the toolbar.
        Specified by:
        getButtonAction in interface ButtonActionIf
        Returns:
        the action to use for the menu and the toolbar or null if the plugin does not provide this feature.
      • onActivation

        void onActivation()
        This method is automatically called after activating the plugin (either during the TV-Browser startup phase or after manually activating the disabled plugin in the settings).
        Since:
        1.1
      • onDeactivation

        void onDeactivation()
        This method is automatically called after deactivating the plugin.
        Since:
        1.1
      • canUseProgramTree

        boolean canUseProgramTree()
        Returns:
        true, if the programs of this plugin are handled by the plugin tree view
        Since:
        1.1
      • handleTvBrowserStartFinished

        void handleTvBrowserStartFinished()
        This method is called when the TV-Browser start is finished.
        Since:
        2.2
      • handlePluginException

        void handlePluginException​(java.lang.Throwable t)
        Handles a runtime exception that was caused by the plugin.
        Parameters:
        t - The exception to handle
        Since:
        2.1
      • getPluginFileName

        java.lang.String getPluginFileName()
        return the file name of the plugin contained in this proxy
        Returns:
        file name
        Since:
        2.6
      • getPluginIcon

        javax.swing.Icon getPluginIcon()
        get the icon to represent this plugin in the settings
        Returns:
        icon
        Since:
        2.6
      • hasArtificialPluginTree

        boolean hasArtificialPluginTree()
      • addToArtificialPluginTree

        void addToArtificialPluginTree​(MutableProgram program)
      • isAllowedToDeleteProgramFilter

        boolean isAllowedToDeleteProgramFilter​(PluginsProgramFilter programFilter)
      • getProgramRatingIfs

        ProgramRatingIf[] getProgramRatingIfs()
        If this plugin can rate programs, this interface makes it possible to offer this ratings to other plugins. You can get all ProgramRatingIfs of all plugins using PluginManager.getAllProgramRatingIfs() The plugin can return more than one ratingif, e.g. average ratings, user rating ...
        Specified by:
        getProgramRatingIfs in interface PluginAccess
        Returns:
        the RatingIfs of this plugin
        Since:
        2.7
      • getContextMenuActions

        ActionMenu getContextMenuActions​(Channel channel)
        Gets the actions for the context menu of a channel.
        Parameters:
        channel - The channel the context menu will be shown for.
        Returns:
        the actions this plugin provides for the given channel or null if the plugin does not provide this feature.
        Since:
        3.0
      • getAfterDataUpdateInfoPanel

        AfterDataUpdateInfoPanel getAfterDataUpdateInfoPanel()
        Gets a panel that contains infos that should be shown for this Plugins after a data update.

        Returns:
        The panel with the infos.
        Since:
        3.2
      • handleTvBrowserSettingsChanged

        void handleTvBrowserSettingsChanged()
        Is called when settings of TV-Browser or Plugins were changed, so this Plugin can react on that change.
        Since:
        3.2
      • handleTvDataUpdateStarted

        void handleTvDataUpdateStarted​(Date until)
        Is called when a TV data update is started.
        Parameters:
        until - The last date the data is updated for.
        Since:
        3.3.3
      • getAddtionalProgramInfoForProgram

        ProgramInfo[] getAddtionalProgramInfoForProgram​(Program p,
                                                        java.lang.String uniqueId)
        Gets additional program infos for the given program. This method should return an array with all possible infos when called with the TV-Browser example Program. Every additional info must have an unique ID, so the name might be changed but the ID never must.

        Parameters:
        p - The program to get the additional program info for.
        uniqueId - If not null the id of the program info to get.
        Returns:
        An array with the additional program info or null if no additional info is available.
        Since:
        3.4.4