com.aelitis.azureus.ui
Interface UIFunctions

All Superinterfaces:
AzureusCoreComponent
All Known Subinterfaces:
UIFunctionsSWT
All Known Implementing Classes:
UIFunctionsImpl

public interface UIFunctions
extends AzureusCoreComponent

Author:
TuxPaper

Nested Class Summary
static interface UIFunctions.actionListener
           
static interface UIFunctions.TagReturner
           
 
Field Summary
static int ACTION_FULL_UPDATE
           
static int ACTION_UPDATE_RESTART_REQUEST
           
static String MAIN_WINDOW_NAME
           
static String MAIN_WINDOW_NAME_PLUS
           
static String OTO_DEFAULT_TO_STOPPED
           
static boolean OTO_DEFAULT_TO_STOPPED_DEFAULT
           
static String OTO_FORCE_OPEN
           
static boolean OTO_FORCE_OPEN_DEFAULT
           
static String OTO_HIDE_ERRORS
           
static boolean OTO_HIDE_ERRORS_DEFAULT
           
static String OTO_SILENT
           
static boolean OTO_SILENT_DEFAULT
           
static int STATUSICON_ERROR
           
static int STATUSICON_NONE
           
static int STATUSICON_WARNING
           
static int VIEW_CONFIG
          Deprecated. Used by rcm
static int VIEW_DM_DETAILS
          Deprecated. Used by rcm
static int VIEW_MYTORRENTS
          Deprecated. Used by azburn
static int VS_ACTIVE
           
static int VS_MINIMIZED
           
static int VS_MINIMIZED_TO_TRAY
           
static int VS_TRAY_ONLY
           
 
Method Summary
 boolean addTorrentWithOptions(boolean force, TorrentOpenOptions torrentOptions)
          Opens the Torrent Add Options Window, if configured to
 boolean addTorrentWithOptions(TorrentOpenOptions torrentOptions, Map<String,Object> addOptions)
           
 int adjustPXForDPI(int px)
           
 void bringToFront()
          Bring main window to the front
 void bringToFront(boolean tryTricks)
          Bring main window to the front
 boolean dispose(boolean for_restart, boolean close_already_in_progress)
          Request the UI be shut down.
 void doSearch(String searchText)
           
 void doSearch(String searchText, boolean toSubscribe)
           
 void forceNotify(int iconID, String title, String text, String details, Object[] relatedObjects, int timeoutSecs)
          Might launch the old-school Mr Slidey
 MultipleDocumentInterface getMDI()
          Retrieve the MDI (Sidebar, TabbedMDI)
 int getUIType()
           
 UIUpdater getUIUpdater()
          Retrieves the class that handles periodically updating the UI
 UIFunctionsUserPrompter getUserPrompter(String title, String text, String[] buttons, int defaultOption)
           
 int getVisibilityState()
           
 void installPlugin(String plugin_id, String resource_prefix, UIFunctions.actionListener listener)
           
 boolean isProgramInstalled(String extension, String name)
           
 void openRemotePairingWindow()
           
 void openView(int viewID, Object datasource)
          Deprecated. Use getMDI()
 void performAction(int action_id, Object args, UIFunctions.actionListener listener)
           
 void playOrStreamDataSource(Object ds, String referal, boolean launch_already_checked, boolean complete_only)
           
 void promptUser(String title, String text, String[] buttons, int defaultOption, String rememberID, String rememberText, boolean bRememberByDefault, int autoCloseInMS, UserPrompterResultListener l)
           
 void refreshIconBar()
           
 void refreshLanguage()
          Change/Refresh the language of the UI
 void runOnUIThread(int ui_type, Runnable runnable)
           
 void setStatusText(int statustype, String string, UIStatusTextClickListener l)
           
 void setStatusText(String string)
           
 void showCreateTagDialog(UIFunctions.TagReturner tagReturner)
           
 void showErrorMessage(String keyPrefix, String details, String[] textParams)
           
 boolean viewURL(String url, String target, double wPct, double hPct, boolean allowResize, boolean isModal)
           
 boolean viewURL(String url, String target, int w, int h, boolean allowResize, boolean isModal)
           
 void viewURL(String url, String target, String sourceRef)
           
 

Field Detail

MAIN_WINDOW_NAME

static final String MAIN_WINDOW_NAME

MAIN_WINDOW_NAME_PLUS

static final String MAIN_WINDOW_NAME_PLUS

STATUSICON_NONE

static final int STATUSICON_NONE
See Also:
Constant Field Values

STATUSICON_WARNING

static final int STATUSICON_WARNING
See Also:
Constant Field Values

STATUSICON_ERROR

static final int STATUSICON_ERROR
See Also:
Constant Field Values

VIEW_MYTORRENTS

static final int VIEW_MYTORRENTS
Deprecated. Used by azburn
See Also:
Constant Field Values

VIEW_CONFIG

static final int VIEW_CONFIG
Deprecated. Used by rcm
See Also:
Constant Field Values

VIEW_DM_DETAILS

static final int VIEW_DM_DETAILS
Deprecated. Used by rcm
See Also:
Constant Field Values

ACTION_FULL_UPDATE

static final int ACTION_FULL_UPDATE
See Also:
Constant Field Values

ACTION_UPDATE_RESTART_REQUEST

static final int ACTION_UPDATE_RESTART_REQUEST
See Also:
Constant Field Values

VS_TRAY_ONLY

static final int VS_TRAY_ONLY
See Also:
Constant Field Values

VS_MINIMIZED_TO_TRAY

static final int VS_MINIMIZED_TO_TRAY
See Also:
Constant Field Values

VS_MINIMIZED

static final int VS_MINIMIZED
See Also:
Constant Field Values

VS_ACTIVE

static final int VS_ACTIVE
See Also:
Constant Field Values

OTO_DEFAULT_TO_STOPPED

static final String OTO_DEFAULT_TO_STOPPED
See Also:
Constant Field Values

OTO_DEFAULT_TO_STOPPED_DEFAULT

static final boolean OTO_DEFAULT_TO_STOPPED_DEFAULT
See Also:
Constant Field Values

OTO_FORCE_OPEN

static final String OTO_FORCE_OPEN
See Also:
Constant Field Values

OTO_FORCE_OPEN_DEFAULT

static final boolean OTO_FORCE_OPEN_DEFAULT
See Also:
Constant Field Values

OTO_SILENT

static final String OTO_SILENT
See Also:
Constant Field Values

OTO_SILENT_DEFAULT

static final boolean OTO_SILENT_DEFAULT
See Also:
Constant Field Values

OTO_HIDE_ERRORS

static final String OTO_HIDE_ERRORS
See Also:
Constant Field Values

OTO_HIDE_ERRORS_DEFAULT

static final boolean OTO_HIDE_ERRORS_DEFAULT
See Also:
Constant Field Values
Method Detail

getUIType

int getUIType()

bringToFront

void bringToFront()
Bring main window to the front


bringToFront

void bringToFront(boolean tryTricks)
Bring main window to the front

Parameters:
tryTricks: - try tricks to force it to the top
Since:
3.0.1.7

getVisibilityState

int getVisibilityState()

refreshLanguage

void refreshLanguage()
Change/Refresh the language of the UI


refreshIconBar

void refreshIconBar()

setStatusText

void setStatusText(String string)
Parameters:
string -

setStatusText

void setStatusText(int statustype,
                   String string,
                   UIStatusTextClickListener l)

dispose

boolean dispose(boolean for_restart,
                boolean close_already_in_progress)
Request the UI be shut down.

Returns:
true - request granted, UI is being shut down false - request denied (example: password entry failed)

viewURL

boolean viewURL(String url,
                String target,
                int w,
                int h,
                boolean allowResize,
                boolean isModal)

viewURL

boolean viewURL(String url,
                String target,
                double wPct,
                double hPct,
                boolean allowResize,
                boolean isModal)

viewURL

void viewURL(String url,
             String target,
             String sourceRef)

getUserPrompter

UIFunctionsUserPrompter getUserPrompter(String title,
                                        String text,
                                        String[] buttons,
                                        int defaultOption)

promptUser

void promptUser(String title,
                String text,
                String[] buttons,
                int defaultOption,
                String rememberID,
                String rememberText,
                boolean bRememberByDefault,
                int autoCloseInMS,
                UserPrompterResultListener l)

getUIUpdater

UIUpdater getUIUpdater()
Retrieves the class that handles periodically updating the UI

Returns:
Since:
3.1.1.1

openView

void openView(int viewID,
              Object datasource)
Deprecated. Use getMDI()


doSearch

void doSearch(String searchText)

doSearch

void doSearch(String searchText,
              boolean toSubscribe)

installPlugin

void installPlugin(String plugin_id,
                   String resource_prefix,
                   UIFunctions.actionListener listener)

performAction

void performAction(int action_id,
                   Object args,
                   UIFunctions.actionListener listener)
Parameters:
action_id -
args -
listener -

getMDI

MultipleDocumentInterface getMDI()
Retrieve the MDI (Sidebar, TabbedMDI)

Returns:

forceNotify

void forceNotify(int iconID,
                 String title,
                 String text,
                 String details,
                 Object[] relatedObjects,
                 int timeoutSecs)
Might launch the old-school Mr Slidey


runOnUIThread

void runOnUIThread(int ui_type,
                   Runnable runnable)

isProgramInstalled

boolean isProgramInstalled(String extension,
                           String name)

openRemotePairingWindow

void openRemotePairingWindow()

playOrStreamDataSource

void playOrStreamDataSource(Object ds,
                            String referal,
                            boolean launch_already_checked,
                            boolean complete_only)

addTorrentWithOptions

boolean addTorrentWithOptions(boolean force,
                              TorrentOpenOptions torrentOptions)
Opens the Torrent Add Options Window, if configured to

Parameters:
force - Override configuration, show it!
Returns:
true if torrent was added

addTorrentWithOptions

boolean addTorrentWithOptions(TorrentOpenOptions torrentOptions,
                              Map<String,Object> addOptions)

showErrorMessage

void showErrorMessage(String keyPrefix,
                      String details,
                      String[] textParams)

showCreateTagDialog

void showCreateTagDialog(UIFunctions.TagReturner tagReturner)

adjustPXForDPI

int adjustPXForDPI(int px)