Class UIFunctionsImpl

java.lang.Object

com.biglybt.ui.swt.shells.main.UIFunctionsImpl

All Implemented Interfaces:

CoreComponent, UIFunctionsSWT, UIFunctions

public class UIFunctionsImpl
extends Object
implements UIFunctionsSWT

Nested Class Summary

Nested classes/interfaces inherited from interface UIFunctions

UIFunctions.actionListener, UIFunctions.TagReturner

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	isTorrentMenuVisible
private static final LogIDs	LOGID
private final MainWindow	mainWindow
private static final String	MSG_ALREADY_EXISTS
private static final String	MSG_ALREADY_EXISTS_NAME
private final ParameterListener	paramShowTorrentsMenuListener
private static final boolean	PROXY_VIEW_URL
private SWTSkin	skin	Stores the current SWTSkin so it can be used by createMainMenu(Shell)

Fields inherited from interface UIFunctions

ACTION_FULL_UPDATE, ACTION_UPDATE_RESTART_REQUEST, MAIN_WINDOW_NAME, OTO_DEFAULT_SAVE_PATH, OTO_DEFAULT_SAVE_PATH_DEFAULT, OTO_DEFAULT_TO_STOPPED, OTO_DEFAULT_TO_STOPPED_DEFAULT, OTO_FORCE_OPEN, OTO_FORCE_OPEN_DEFAULT, OTO_HIDE_ERRORS, OTO_HIDE_ERRORS_DEFAULT, OTO_SILENT, OTO_SILENT_DEFAULT, STATUSICON_ERROR, STATUSICON_NONE, STATUSICON_WARNING, VS_ACTIVE, VS_MINIMIZED, VS_MINIMIZED_TO_TRAY, VS_TRAY_ONLY

Constructor Summary

Constructors

Constructor	Description
UIFunctionsImpl(MainWindow window)

Method Summary

Modifier and Type	Method	Description
boolean	addTorrentWithOptions(boolean force, TorrentOpenOptions torrentOptions)	Opens the Torrent Add Options Window, if configured to
boolean	addTorrentWithOptions(TorrentOpenOptions torrentOptions, Map<String,Object> addOptions)
private boolean	addTorrentWithOptionsSupport(TorrentOpenOptions torrentOptions, Map<String,Object> addOptions, boolean is_silent)
void	bringToFront()	Bring main window to the front
void	bringToFront(boolean tryTricks)	Bring main window to the front
private static boolean	checkForSpecialSearchTerm(String str)
void	closeAllDetails()
void	closeDownloadBars()
void	closeGlobalTransferBar()
void	copyToClipboard(String text)
IMainMenu	createMainMenu(org.eclipse.swt.widgets.Shell shell)	Creates the main application menu and attach it to the given Shell; this is only used for OSX so that we can attach the global menu to popup dialogs which is the expected behavior on OSX.
void	dispose()
boolean	dispose(boolean for_restart)
void	doSearch(String sSearchText)
void	doSearch(String sSearchText, boolean toSubscribe)
void	forceNotify(int iconID, String title, String text, String details, Object[] relatedObjects, int timeoutSecs)	Might launch the old-school Mr Slidey
boolean	getHideAll()
org.eclipse.swt.widgets.Shell	getMainShell()
IMainStatusBar	getMainStatusBar()
IMainWindow	getMainWindow()
MultipleDocumentInterface	getMDI()	Retrieve the MDI (Sidebar, TabbedMDI)
MultipleDocumentInterfaceSWT	getMDISWT()
UISWTView[]	getPluginViews()
SWTSkin	getSkin()
UIToolBarManager	getToolBarManager()
List<TorrentOpenOptions>	getTorrentOptions()
UISWTInstance	getUISWTInstance()
String	getUIType()
UIUpdater	getUIUpdater()	Retrieves the class that handles periodically updating the UI
UIFunctionsUserPrompter	getUserPrompter(String title, String text, String[] buttons, int defaultOption)
int	getVisibilityState()
boolean	hasDetailViews()
void	installPlugin(String plugin_id, String resource_prefix, UIFunctions.actionListener listener)
boolean	isGlobalTransferBarShown()
boolean	isProgramInstalled(String extension, String name)
boolean	isUIThread()
void	openPluginView(UISWTViewBuilderCore builder, boolean bSetFocus)
void	openRemotePairingWindow()
void	openTorrentOpenOptions(org.eclipse.swt.widgets.Shell shell, String sPathOfFilesToOpen, String[] sFilesToOpen, boolean defaultToStopped, boolean forceOpen)
void	openTorrentOpenOptions(org.eclipse.swt.widgets.Shell shell, String sPathOfFilesToOpen, String[] sFilesToOpen, Map<String,Object> options)
void	openTorrentWindow()
void	performAction(int action_id, Object args, UIFunctions.actionListener listener)
void	playOrStreamDataSource(Object ds, String referal, boolean launch_already_checked, boolean complete_only)
void	popStatusText(Object o, int reason, String message)
void	promptForSearch()
void	promptUser(String title, String text, String[] buttons, int defaultOption, String rememberID, String rememberText, boolean rememberByDefault, int autoCloseInMS, UserPrompterResultListener l)
Object	pushStatusText(String key)
void	refreshIconBar()
void	refreshLanguage()	Change/Refresh the language of the UI
void	refreshTorrentMenu()
void	runOnUIThread(String ui_type, Runnable runnable)
void	setHideAll(boolean hidden)
void	setSkin(SWTSkin skin)
void	setStatusText(int statustype, String key, UIStatusTextClickListener l)
void	setStatusText(String key)
org.eclipse.swt.widgets.Shell	showCoreWaitDlg()
void	showCreateTagDialog(UIFunctions.TagReturner tagReturner)
void	showErrorMessage(String keyPrefix, String details, String[] textParams)
void	showGlobalTransferBar()
void	showInExplorer(File f)
void	showText(String title, String content)
private void	showURL(String url, String target)
void	tableColumnAddedListeners(TableColumnImpl tableColumn, Object listeners)
boolean	viewURL(String url, String target, double w, double h, 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)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface UIFunctions

dispose

Field Details

PROXY_VIEW_URL

private static final boolean PROXY_VIEW_URL

See Also:

• Constant Field Values

MSG_ALREADY_EXISTS

private static final String MSG_ALREADY_EXISTS

See Also:

• Constant Field Values

MSG_ALREADY_EXISTS_NAME

private static final String MSG_ALREADY_EXISTS_NAME

See Also:

• Constant Field Values

LOGID

private static final LogIDs LOGID

mainWindow

private final MainWindow mainWindow

skin

private SWTSkin skin

Stores the current SWTSkin so it can be used by createMainMenu(Shell)

isTorrentMenuVisible

protected boolean isTorrentMenuVisible

paramShowTorrentsMenuListener

private final ParameterListener paramShowTorrentsMenuListener

Constructor Details

UIFunctionsImpl

public UIFunctionsImpl(MainWindow window)

Parameters:

window -

Method Details

getUIType

public String getUIType()

Specified by:

getUIType in interface UIFunctions

bringToFront

public void bringToFront()

Description copied from interface: UIFunctions

Bring main window to the front

Specified by:

bringToFront in interface UIFunctions

bringToFront

public void bringToFront(boolean tryTricks)

Description copied from interface: UIFunctions

Bring main window to the front

Specified by:

bringToFront in interface UIFunctions

Parameters:

tryTricks - : try tricks to force it to the top

getVisibilityState

public int getVisibilityState()

Specified by:

getVisibilityState in interface UIFunctions

closeDownloadBars

public void closeDownloadBars()

Specified by:

closeDownloadBars in interface UIFunctionsSWT

dispose

public boolean dispose(boolean for_restart)

Specified by:

dispose in interface UIFunctions

getMainShell

public org.eclipse.swt.widgets.Shell getMainShell()

Specified by:

getMainShell in interface UIFunctionsSWT

getPluginViews

public UISWTView[] getPluginViews()

Specified by:

getPluginViews in interface UIFunctionsSWT

Returns:

openPluginView

public void openPluginView(UISWTViewBuilderCore builder,
 boolean bSetFocus)

Specified by:

openPluginView in interface UIFunctionsSWT

refreshIconBar

public void refreshIconBar()

Specified by:

refreshIconBar in interface UIFunctions

refreshLanguage

public void refreshLanguage()

Description copied from interface: UIFunctions

Change/Refresh the language of the UI

Specified by:

refreshLanguage in interface UIFunctions

setStatusText

public void setStatusText(String key)

Specified by:

setStatusText in interface UIFunctions

Parameters:

key -

setStatusText

public void setStatusText(int statustype,
 String key,
 UIStatusTextClickListener l)

Specified by:

setStatusText in interface UIFunctions

pushStatusText

public Object pushStatusText(String key)

Specified by:

pushStatusText in interface UIFunctions

popStatusText

public void popStatusText(Object o,
 int reason,
 String message)

Specified by:

popStatusText in interface UIFunctions

getMainStatusBar

public IMainStatusBar getMainStatusBar()

Specified by:

getMainStatusBar in interface UIFunctionsSWT

getUISWTInstance

public UISWTInstance getUISWTInstance()

Specified by:

getUISWTInstance in interface UIFunctionsSWT

viewURL

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

Specified by:

viewURL in interface UIFunctions

viewURL

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

Specified by:

viewURL in interface UIFunctions

viewURL

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

Specified by:

viewURL in interface UIFunctions

showURL

private void showURL(String url,
 String target)

Parameters:

url -

target -

promptUser

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

Specified by:

promptUser in interface UIFunctions

getUserPrompter

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

Specified by:

getUserPrompter in interface UIFunctions

isGlobalTransferBarShown

public boolean isGlobalTransferBarShown()

Specified by:

isGlobalTransferBarShown in interface UIFunctionsSWT

showGlobalTransferBar

public void showGlobalTransferBar()

Specified by:

showGlobalTransferBar in interface UIFunctionsSWT

closeGlobalTransferBar

public void closeGlobalTransferBar()

Specified by:

closeGlobalTransferBar in interface UIFunctionsSWT

refreshTorrentMenu

public void refreshTorrentMenu()

Specified by:

refreshTorrentMenu in interface UIFunctionsSWT

createMainMenu

public IMainMenu createMainMenu(org.eclipse.swt.widgets.Shell shell)

Description copied from interface: UIFunctionsSWT

Creates the main application menu and attach it to the given Shell; this is only used for OSX so that we can attach the global menu to popup dialogs which is the expected behavior on OSX. Windows and Linux do not require this since they do not have a global menu and because their main menu is already attached to the main application window.

Specified by:

createMainMenu in interface UIFunctionsSWT

Parameters:

shell -

Returns:

getSkin

public SWTSkin getSkin()

setSkin

public void setSkin(SWTSkin skin)

getMainWindow

public IMainWindow getMainWindow()

Specified by:

getMainWindow in interface UIFunctionsSWT

getUIUpdater

public UIUpdater getUIUpdater()

Description copied from interface: UIFunctions

Retrieves the class that handles periodically updating the UI

Specified by:

getUIUpdater in interface UIFunctions

Returns:

closeAllDetails

public void closeAllDetails()

Specified by:

closeAllDetails in interface UIFunctionsSWT

hasDetailViews

public boolean hasDetailViews()

Specified by:

hasDetailViews in interface UIFunctionsSWT

Returns:

performAction

public void performAction(int action_id,
 Object args,
 UIFunctions.actionListener listener)

Specified by:

performAction in interface UIFunctions

Parameters:

action_id -

args -

listener -

showCoreWaitDlg

public org.eclipse.swt.widgets.Shell showCoreWaitDlg()

Specified by:

showCoreWaitDlg in interface UIFunctionsSWT

doSearch

public void doSearch(String sSearchText)

Specified by:

doSearch in interface UIFunctions

Parameters:

sSearchText -

doSearch

public void doSearch(String sSearchText,
 boolean toSubscribe)

Specified by:

doSearch in interface UIFunctions

checkForSpecialSearchTerm

private static boolean checkForSpecialSearchTerm(String str)

promptForSearch

public void promptForSearch()

Specified by:

promptForSearch in interface UIFunctionsSWT

getMDI

public MultipleDocumentInterface getMDI()

Description copied from interface: UIFunctions

Retrieve the MDI (Sidebar, TabbedMDI)

Specified by:

getMDI in interface UIFunctions

Returns:

getMDISWT

public MultipleDocumentInterfaceSWT getMDISWT()

Specified by:

getMDISWT in interface UIFunctionsSWT

showErrorMessage

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

Specified by:

showErrorMessage in interface UIFunctions

Parameters:

keyPrefix -

details - may not get displayed

textParams -

forceNotify

public void forceNotify(int iconID,
 String title,
 String text,
 String details,
 Object[] relatedObjects,
 int timeoutSecs)

Description copied from interface: UIFunctions

Might launch the old-school Mr Slidey

Specified by:

forceNotify in interface UIFunctions

installPlugin

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

Specified by:

installPlugin in interface UIFunctions

getToolBarManager

public UIToolBarManager getToolBarManager()

Specified by:

getToolBarManager in interface UIFunctionsSWT

runOnUIThread

public void runOnUIThread(String ui_type,
 Runnable runnable)

Specified by:

runOnUIThread in interface UIFunctions

isUIThread

public boolean isUIThread()

Specified by:

isUIThread in interface UIFunctions

isProgramInstalled

public boolean isProgramInstalled(String extension,
 String name)

Specified by:

isProgramInstalled in interface UIFunctions

openRemotePairingWindow

public void openRemotePairingWindow()

Specified by:

openRemotePairingWindow in interface UIFunctions

playOrStreamDataSource

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

Specified by:

playOrStreamDataSource in interface UIFunctions

setHideAll

public void setHideAll(boolean hidden)

Specified by:

setHideAll in interface UIFunctionsSWT

getHideAll

public boolean getHideAll()

Specified by:

getHideAll in interface UIFunctionsSWT

addTorrentWithOptions

public boolean addTorrentWithOptions(boolean force,
 TorrentOpenOptions torrentOptions)

Description copied from interface: UIFunctions

Opens the Torrent Add Options Window, if configured to

Specified by:

addTorrentWithOptions in interface UIFunctions

Parameters:

force - Override configuration, show it!

Returns:

true if torrent was added

addTorrentWithOptions

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

Specified by:

addTorrentWithOptions in interface UIFunctions

addTorrentWithOptionsSupport

private boolean addTorrentWithOptionsSupport(TorrentOpenOptions torrentOptions,
 Map<String,Object> addOptions,
 boolean is_silent)

openTorrentOpenOptions

public void openTorrentOpenOptions(org.eclipse.swt.widgets.Shell shell,
 String sPathOfFilesToOpen,
 String[] sFilesToOpen,
 boolean defaultToStopped,
 boolean forceOpen)

Specified by:

openTorrentOpenOptions in interface UIFunctionsSWT

openTorrentOpenOptions

public void openTorrentOpenOptions(org.eclipse.swt.widgets.Shell shell,
 String sPathOfFilesToOpen,
 String[] sFilesToOpen,
 Map<String,Object> options)

Specified by:

openTorrentOpenOptions in interface UIFunctionsSWT

Parameters:

shell -

sPathOfFilesToOpen -

sFilesToOpen -

options - See UIFunctions constants

getTorrentOptions

public List<TorrentOpenOptions> getTorrentOptions()

Specified by:

getTorrentOptions in interface UIFunctions

openTorrentWindow

public void openTorrentWindow()

Specified by:

openTorrentWindow in interface UIFunctionsSWT

showCreateTagDialog

public void showCreateTagDialog(UIFunctions.TagReturner tagReturner)

Specified by:

showCreateTagDialog in interface UIFunctions

tableColumnAddedListeners

public void tableColumnAddedListeners(TableColumnImpl tableColumn,
 Object listeners)

Specified by:

tableColumnAddedListeners in interface UIFunctions

copyToClipboard

public void copyToClipboard(String text)

Specified by:

copyToClipboard in interface UIFunctions

showInExplorer

public void showInExplorer(File f)

Specified by:

showInExplorer in interface UIFunctions

showText

public void showText(String title,
 String content)

Specified by:

showText in interface UIFunctions

dispose

public void dispose()