Interface UIManager

All Known Implementing Classes:
UIManagerImpl

public interface UIManager
Management tools for the user interface.

To get an UIManager, see PluginInterface.getUIManager()

  • Field Details

  • Method Details

    • createBasicPluginConfigModel

      BasicPluginConfigModel createBasicPluginConfigModel(String section_name)
      Creates a basic plugin view model and places it inside the plugins section of the configuration page.
      Parameters:
      section_name - Message Bundle resource id for the config model. This will be used as the name of the config page, as well as an unique id
      Returns:
      BasicPluginConfigModel
      Since:
      2.1.0.0
    • createBasicPluginConfigModel

      BasicPluginConfigModel createBasicPluginConfigModel(String parent_section, String section_name)
      Creates a basic plugin view model and adds it to the plugin in one step. view is placed inside the plugins section of the configuration page.
      Parameters:
      parent_section - see ConfigSection.SECTION_*
      section_name - Message Bundle resource id for the config model. This will be used as the name of the config page, as well as an unique id
      Returns:
      BasicPluginConfigModel
      Since:
      2.1.0.0
    • getPluginConfigModels

      PluginConfigModel[] getPluginConfigModels()
      Returns:
      Since:
      2.5.0.1
    • createBasicPluginViewModel

      BasicPluginViewModel createBasicPluginViewModel(String name)
      Creates a basic plugin view model and adds it to the plugin in one step.
      Parameters:
      name - The name for the view (this should be localised text, rather than a message string).
      Returns:
      BasicPluginViewModel
      Since:
      2.1.0.2
    • createLoggingViewModel

      BasicPluginViewModel createLoggingViewModel(LoggerChannel channel, boolean use_plugin_name)
      Creates a BasicPluginViewModel object primarily to be used for storing logging output. This is just a shortcut way of creating a log view for the logger channel.
      Parameters:
      channel - The LoggerChannel to associate with.
      use_plugin_name - If set to true, the log view will be taken from the plugin name, if false, it will be taken from the channel name.
      Since:
      3.1.1.1
    • copyToClipBoard

      void copyToClipBoard(String data) throws UIException
      Parameters:
      data -
      Throws:
      UIException
      Since:
      2.1.0.0
    • getTableManager

      TableManager getTableManager()
      Retrieve the Table Manager
      Returns:
      Table management functions
      Since:
      2.1.0.0
    • showTextMessage

      void showTextMessage(String title_resource, String message_resource, String contents)
      Parameters:
      title_resource -
      message_resource -
      contents -
      Since:
      2.3.0.5
    • showMessageBox

      long showMessageBox(String title_resource, String message_resource, long message_map)
      Parameters:
      title_resource -
      message_resource -
      message_map - - see UIManagerEvent.MT_x
      Returns:
      selected value
      Since:
      3.0.5.3
    • showMessageBox

      long showMessageBox(String title_resource, String message_resource, long message_map, Object[] params)
      Parameters:
      title_resource -
      message_resource -
      message_map - - see UIManagerEvent.MT_x
      params - - [ remember-id (String), remember-by-default (Boolean), remember-resource (String) ]
      Returns:
      selected value
      Since:
      4.8.1.3
    • showMessageBox

      long showMessageBox(String title_resource, String message_resource, long message_map, Map<String,Object> params)
      Parameters:
      title_resource -
      message_resource -
      message_map -
      params -
      Returns:
      Since:
      5621
    • openURL

      void openURL(URL url) throws UIException
      Parameters:
      url -
      Throws:
      UIException
      Since:
      2.3.0.6
    • openTorrent

      void openTorrent(Torrent torrent)
      Parameters:
      torrent -
      Since:
      3.0.5.3
    • showConfigSection

      boolean showConfigSection(String sectionID)
      Open Config View to the section specified
      Parameters:
      sectionID - ID of section to open to. ConfigSection.SECTION_* constants
      Returns:
      true-Section opened; false-Section invalid or UI does not support config views
      Since:
      2.3.0.7
    • getMenuManager

      MenuManager getMenuManager()
      Retrieve the menu manager.
      Returns:
      Menu management functions
      Since:
      3.0.0.7
    • attachUI

      void attachUI(UIInstanceFactory factory) throws UIException
      attach a new UI
      Parameters:
      factory -
      Throws:
      UIException
      Since:
      2.3.0.5
    • detachUI

      void detachUI(UIInstanceFactory factory) throws UIException
      detach a UI - can fail if the UI doesn't support detaching
      Parameters:
      factory -
      Throws:
      UIException
      Since:
      2.3.0.5
    • addUIListener

      void addUIListener(UIManagerListener listener)
      Listen for UIManagerListener.UIAttached(UIInstance) and UIManagerListener.UIDetached(UIInstance) events. Typically, you hook this listener so you can access
      invalid reference
      UISWTInstance
      when it gets created.

      Will fire UIAttached for managers already attached

      Since:
      2.3.0.5
    • removeUIListener

      void removeUIListener(UIManagerListener listener)
      Remove an existing UIManagerListener
      Parameters:
      listener - Listener to remove
      Since:
      2.3.0.5
    • addUIEventListener

      void addUIEventListener(UIManagerEventListener listener)
      Add a listener that's triggered on when core/plugins need to do an UI-only task, such as display a message to a user, or open an URL in a browser.

      See UIManagerEvent for types of events

      Since:
      2.3.0.5
    • removeUIEventListener

      void removeUIEventListener(UIManagerEventListener listener)
      Remove previously added UIManagerEventListener
      Since:
      2.3.0.5
    • hasUIInstances

      boolean hasUIInstances()
      Returns true if there any user interfaces currently attached to Azureus. Note that this value may change over time, and that at the point when a plugin is being initialised, there is no guarantee over whether if the user interfaces will have been created yet or not. If you want to monitor what user interfaces are being attached / detached from Azureus, you should add a UIListener to this object.
      Since:
      3.0.0.7
    • getUIInstances

      UIInstance[] getUIInstances()
      Returns an array of all currently attached user interfaces. Note that this value may change over time, and that at the point when a plugin is being initialised, there is no guarantee over whether if the user interfaces will have been created yet or not. If you want to monitor what user interfaces are being attached / detached from Azureus, you should add a UIListener to this object.
      Since:
      3.0.0.7
    • getInputReceiver

      UIInputReceiver getInputReceiver()
      Retrieves a UIInputReceiver from any interface available, or returns null if one is not available. This is a convenience method to allow you to grab an instance without having to iterate over any attached interfaces.
      Since:
      3.0.5.3
      See Also:
    • createMessage

      UIMessage createMessage()
      Retrieves a UIMessage from any interface available, or returns null if one is not available. This is a convenience method to allow you to grab an instance without having to iterate over any attached interfaces.
      Since:
      3.0.5.3
      See Also:
    • openFile

      void openFile(File file)
      Opens up the file using the associated application.
      Parameters:
      file - The file to open.
      Since:
      3.0.5.3
    • showFile

      void showFile(File file)
      Shows the file in a file explorer application in its parent folder.
      Parameters:
      file - The file to show.
      Since:
      3.0.5.3
    • addDataSourceListener

      void addDataSourceListener(UIDataSourceListener l, boolean triggerNow)
    • removeDataSourceListener

      void removeDataSourceListener(UIDataSourceListener l)
    • getDataSource

      Object getDataSource()
    • setEverythingHidden

      void setEverythingHidden(boolean hidden)
    • toggleEverythingHidden

      void toggleEverythingHidden()
      Since:
      BiglyBT 1.2.0.1