Package com.biglybt.ui
Interface UIFunctions
-
- All Superinterfaces:
CoreComponent
- All Known Subinterfaces:
UIFunctionsSWT
- All Known Implementing Classes:
MainWindowDelayStub.UIFunctionsSWTImpl
,UIFunctionsImpl
public interface UIFunctions extends CoreComponent
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interface
UIFunctions.actionListener
static interface
UIFunctions.TagReturner
-
Field Summary
Fields Modifier and Type Field Description static int
ACTION_FULL_UPDATE
static int
ACTION_UPDATE_RESTART_REQUEST
static java.lang.String
MAIN_WINDOW_NAME
static java.lang.String
OTO_DEFAULT_SAVE_PATH
static java.lang.String
OTO_DEFAULT_SAVE_PATH_DEFAULT
static java.lang.String
OTO_DEFAULT_TO_STOPPED
static boolean
OTO_DEFAULT_TO_STOPPED_DEFAULT
static java.lang.String
OTO_FORCE_OPEN
static boolean
OTO_FORCE_OPEN_DEFAULT
static java.lang.String
OTO_HIDE_ERRORS
static boolean
OTO_HIDE_ERRORS_DEFAULT
static java.lang.String
OTO_SILENT
static boolean
OTO_SILENT_DEFAULT
static int
STATUSICON_ERROR
static int
STATUSICON_NONE
static int
STATUSICON_WARNING
static int
VS_ACTIVE
static int
VS_MINIMIZED
static int
VS_MINIMIZED_TO_TRAY
static int
VS_TRAY_ONLY
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods Modifier and Type Method Description boolean
addTorrentWithOptions(boolean force, TorrentOpenOptions torrentOptions)
Opens the Torrent Add Options Window, if configured toboolean
addTorrentWithOptions(TorrentOpenOptions torrentOptions, java.util.Map<java.lang.String,java.lang.Object> addOptions)
void
bringToFront()
Bring main window to the frontvoid
bringToFront(boolean tryTricks)
Bring main window to the frontvoid
copyToClipboard(java.lang.String text)
boolean
dispose(boolean for_restart)
default boolean
dispose(boolean for_restart, boolean UNUSED)
Deprecated.void
doSearch(java.lang.String searchText)
void
doSearch(java.lang.String searchText, boolean toSubscribe)
void
forceNotify(int iconID, java.lang.String title, java.lang.String text, java.lang.String details, java.lang.Object[] relatedObjects, int timeoutSecs)
Might launch the old-school Mr SlideyMultipleDocumentInterface
getMDI()
Retrieve the MDI (Sidebar, TabbedMDI)java.lang.String
getUIType()
UIUpdater
getUIUpdater()
Retrieves the class that handles periodically updating the UIUIFunctionsUserPrompter
getUserPrompter(java.lang.String title, java.lang.String text, java.lang.String[] buttons, int defaultOption)
int
getVisibilityState()
void
installPlugin(java.lang.String plugin_id, java.lang.String resource_prefix, UIFunctions.actionListener listener)
boolean
isProgramInstalled(java.lang.String extension, java.lang.String name)
boolean
isUIThread()
void
openRemotePairingWindow()
void
performAction(int action_id, java.lang.Object args, UIFunctions.actionListener listener)
void
playOrStreamDataSource(java.lang.Object ds, java.lang.String referal, boolean launch_already_checked, boolean complete_only)
void
promptUser(java.lang.String title, java.lang.String text, java.lang.String[] buttons, int defaultOption, java.lang.String rememberID, java.lang.String rememberText, boolean bRememberByDefault, int autoCloseInMS, UserPrompterResultListener l)
void
refreshIconBar()
void
refreshLanguage()
Change/Refresh the language of the UIvoid
runOnUIThread(java.lang.String ui_type, java.lang.Runnable runnable)
void
setStatusText(int statustype, java.lang.String key, UIStatusTextClickListener l)
void
setStatusText(java.lang.String key)
void
showCreateTagDialog(UIFunctions.TagReturner tagReturner)
void
showErrorMessage(java.lang.String keyPrefix, java.lang.String details, java.lang.String[] textParams)
void
showInExplorer(java.io.File f)
void
showText(java.lang.String title, java.lang.String content)
void
tableColumnAddedListeners(TableColumnImpl tableColumn, java.lang.Object listeners)
boolean
viewURL(java.lang.String url, java.lang.String target, double wPct, double hPct, boolean allowResize, boolean isModal)
boolean
viewURL(java.lang.String url, java.lang.String target, int w, int h, boolean allowResize, boolean isModal)
void
viewURL(java.lang.String url, java.lang.String target, java.lang.String sourceRef)
-
-
-
Field Detail
-
MAIN_WINDOW_NAME
static final java.lang.String MAIN_WINDOW_NAME
-
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
-
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 java.lang.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 java.lang.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 java.lang.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 java.lang.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
-
OTO_DEFAULT_SAVE_PATH
static final java.lang.String OTO_DEFAULT_SAVE_PATH
- See Also:
- Constant Field Values
-
OTO_DEFAULT_SAVE_PATH_DEFAULT
static final java.lang.String OTO_DEFAULT_SAVE_PATH_DEFAULT
-
-
Method Detail
-
getUIType
java.lang.String 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(java.lang.String key)
- Parameters:
key
-
-
setStatusText
void setStatusText(int statustype, java.lang.String key, UIStatusTextClickListener l)
-
dispose
default boolean dispose(boolean for_restart, boolean UNUSED)
Deprecated.Request the UI be shut down.- Returns:
- true - request granted, UI is being shut down false - request denied (example: password entry failed)
-
dispose
boolean dispose(boolean for_restart)
-
viewURL
boolean viewURL(java.lang.String url, java.lang.String target, int w, int h, boolean allowResize, boolean isModal)
-
viewURL
boolean viewURL(java.lang.String url, java.lang.String target, double wPct, double hPct, boolean allowResize, boolean isModal)
-
viewURL
void viewURL(java.lang.String url, java.lang.String target, java.lang.String sourceRef)
-
getUserPrompter
UIFunctionsUserPrompter getUserPrompter(java.lang.String title, java.lang.String text, java.lang.String[] buttons, int defaultOption)
-
promptUser
void promptUser(java.lang.String title, java.lang.String text, java.lang.String[] buttons, int defaultOption, java.lang.String rememberID, java.lang.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
-
doSearch
void doSearch(java.lang.String searchText)
-
doSearch
void doSearch(java.lang.String searchText, boolean toSubscribe)
-
installPlugin
void installPlugin(java.lang.String plugin_id, java.lang.String resource_prefix, UIFunctions.actionListener listener)
-
performAction
void performAction(int action_id, java.lang.Object args, UIFunctions.actionListener listener)
- Parameters:
action_id
-args
-listener
-
-
getMDI
MultipleDocumentInterface getMDI()
Retrieve the MDI (Sidebar, TabbedMDI)- Returns:
-
forceNotify
void forceNotify(int iconID, java.lang.String title, java.lang.String text, java.lang.String details, java.lang.Object[] relatedObjects, int timeoutSecs)
Might launch the old-school Mr Slidey
-
runOnUIThread
void runOnUIThread(java.lang.String ui_type, java.lang.Runnable runnable)
-
isUIThread
boolean isUIThread()
-
isProgramInstalled
boolean isProgramInstalled(java.lang.String extension, java.lang.String name)
-
openRemotePairingWindow
void openRemotePairingWindow()
-
playOrStreamDataSource
void playOrStreamDataSource(java.lang.Object ds, java.lang.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, java.util.Map<java.lang.String,java.lang.Object> addOptions)
-
showErrorMessage
void showErrorMessage(java.lang.String keyPrefix, java.lang.String details, java.lang.String[] textParams)
-
showCreateTagDialog
void showCreateTagDialog(UIFunctions.TagReturner tagReturner)
-
tableColumnAddedListeners
void tableColumnAddedListeners(TableColumnImpl tableColumn, java.lang.Object listeners)
-
copyToClipboard
void copyToClipboard(java.lang.String text)
-
showInExplorer
void showInExplorer(java.io.File f)
-
showText
void showText(java.lang.String title, java.lang.String content)
-
-