Package com.biglybt.ui.mdi

Interface MultipleDocumentInterface

All Known Subinterfaces:

MultipleDocumentInterfaceSWT, TabbedMdiInterface

All Known Implementing Classes:

BaseMDI, SideBar, TabbedMDI

public interface MultipleDocumentInterface

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SIDEBAR_HEADER_DASHBOARD
static final String	SIDEBAR_HEADER_DEVICES
static final String	SIDEBAR_HEADER_DISCOVERY
static final String[]	SIDEBAR_HEADER_ORDER_DEFAULT
static final String	SIDEBAR_HEADER_PLUGINS
static final String	SIDEBAR_HEADER_TRANSFERS
static final String	SIDEBAR_HEADER_VUZE
static final String	SIDEBAR_POS_FIRST
static final String	SIDEBAR_SECTION_ACTIVITIES
static final String	SIDEBAR_SECTION_ALL_TRACKERS
static final String	SIDEBAR_SECTION_ALLBLOCKS
static final String	SIDEBAR_SECTION_ALLPEERS
static final String	SIDEBAR_SECTION_ALLPIECES
static final String	SIDEBAR_SECTION_ARCHIVED_DOWNLOADS
static final String	SIDEBAR_SECTION_BETAPROGRAM
static final String	SIDEBAR_SECTION_CHAT
static final String	SIDEBAR_SECTION_CLIENT_STATS
static final String	SIDEBAR_SECTION_CONFIG
static final String	SIDEBAR_SECTION_DEVICES
static final String	SIDEBAR_SECTION_DISK_OPS
static final String	SIDEBAR_SECTION_DOWNLOAD_HISTORY
static final String	SIDEBAR_SECTION_LIBRARY
static final String	SIDEBAR_SECTION_LIBRARY_CAT_INSTANCES
static final String	SIDEBAR_SECTION_LIBRARY_CD
static final String	SIDEBAR_SECTION_LIBRARY_DL
static final String	SIDEBAR_SECTION_LIBRARY_TAG_INSTANCES
static final String	SIDEBAR_SECTION_LIBRARY_UNOPENED
static final String	SIDEBAR_SECTION_LOGGER
static final String	SIDEBAR_SECTION_MY_SHARES
static final String	SIDEBAR_SECTION_MY_TRACKER
static final String	SIDEBAR_SECTION_PLUGINS
static final String	SIDEBAR_SECTION_SEARCH
static final String	SIDEBAR_SECTION_SUBSCRIPTIONS
static final String	SIDEBAR_SECTION_TAG_DISCOVERY
static final String	SIDEBAR_SECTION_TAGS
static final String	SIDEBAR_SECTION_TORRENT_DETAILS
static final String	SIDEBAR_SECTION_TORRENT_OPTIONS
static final String	SIDEBAR_SECTION_WELCOME
static final String[]	SIDEBAR_TRANSFERS_SECTION_ORDER

Method Summary

Modifier and Type	Method	Description
void	addListener(MdiEntryLoadedListener l)
void	addListener(MdiListener l)
MdiEntry	closeEntry(MdiEntry entry, boolean userInitiated)	Close MdiEntry
void	closeEntry(String id)	Deprecated. Use closeEntryByID(String)
MdiEntry	closeEntryByID(String id)	Close MdiEntry of id
MdiEntry	createEntryFromSkinRef(String parentEntryID, String id, String configID, String title, ViewTitleInfo titleInfo, Object params, boolean closeable, String preferedAfterID)	If you prefix the 'preferedAfterID' string with '~' then the operation will actually switch to 'preferedBeforeID'
MdiEntry	createHeader(String id, String title, String preferredAfterID)
void	deregisterEntry(String id, MdiEntryCreationListener l)
void	deregisterEntry(String id, MdiEntryCreationListener2 mdiEntryCreationListener2)
boolean	entryExists(String id)
List<MdiEntry>	getChildrenOf(String id)
Class	getDataSourceType()
MdiEntry[]	getEntries()
int	getEntriesCount()
MdiEntry	getEntry(String id)
MdiEntry	getEntry(String id, Object datasource)
MdiEntry	getMenuEntry(boolean activeOnly)
String[]	getPreferredOrder()
MdiEntry	getSelectedEntry()
String	getViewID()
boolean	isDisposed()
boolean	isInitialized()
boolean	isVisible()
boolean	loadEntryByID(String id, boolean activate)
boolean	loadEntryByID(String id, boolean activate, boolean onlyLoadOnce, Object datasource)
boolean	popoutEntryByID(String id, Object datasource, Map<String,Object> options)
void	registerEntry(String id, MdiEntryCreationListener l)
void	registerEntry(String id, MdiEntryCreationListener2 mdiEntryCreationListener2)
void	removeEntryAutoOpen(String id)
void	removeItem(MdiEntry entry)
void	removeListener(MdiEntryLoadedListener l)
void	removeListener(MdiListener l)
void	runWhenIdle(Runnable r)
void	setDefaultEntryID(String def)
void	setEntryAutoOpen(String id, Map autoOpenInfo)	When an entry can not be opened (ie.
void	setPreferredOrder(String[] preferredOrder)
void	showEntry(MdiEntry newEntry)
boolean	showEntryByID(String id)
boolean	showEntryByID(String id, Object datasource)
boolean	willEntryAutoOpen(String id)

Field Details

SIDEBAR_POS_FIRST

static final String SIDEBAR_POS_FIRST

See Also:

• Constant Field Values

SIDEBAR_HEADER_VUZE

static final String SIDEBAR_HEADER_VUZE

See Also:

• Constant Field Values

SIDEBAR_HEADER_DASHBOARD

static final String SIDEBAR_HEADER_DASHBOARD

See Also:

• Constant Field Values

SIDEBAR_HEADER_TRANSFERS

static final String SIDEBAR_HEADER_TRANSFERS

See Also:

• Constant Field Values

SIDEBAR_HEADER_DISCOVERY

static final String SIDEBAR_HEADER_DISCOVERY

See Also:

• Constant Field Values

SIDEBAR_HEADER_DEVICES

static final String SIDEBAR_HEADER_DEVICES

See Also:

• Constant Field Values

SIDEBAR_HEADER_PLUGINS

static final String SIDEBAR_HEADER_PLUGINS

See Also:

• Constant Field Values

SIDEBAR_HEADER_ORDER_DEFAULT

static final String[] SIDEBAR_HEADER_ORDER_DEFAULT

SIDEBAR_SECTION_PLUGINS

static final String SIDEBAR_SECTION_PLUGINS

See Also:

• Constant Field Values

SIDEBAR_SECTION_LIBRARY

static final String SIDEBAR_SECTION_LIBRARY

See Also:

• Constant Field Values

SIDEBAR_SECTION_BETAPROGRAM

static final String SIDEBAR_SECTION_BETAPROGRAM

See Also:

• Constant Field Values

SIDEBAR_SECTION_LIBRARY_DL

static final String SIDEBAR_SECTION_LIBRARY_DL

See Also:

• Constant Field Values

SIDEBAR_SECTION_LIBRARY_CD

static final String SIDEBAR_SECTION_LIBRARY_CD

See Also:

• Constant Field Values

SIDEBAR_SECTION_TAGS

static final String SIDEBAR_SECTION_TAGS

See Also:

• Constant Field Values

SIDEBAR_SECTION_TAG_DISCOVERY

static final String SIDEBAR_SECTION_TAG_DISCOVERY

See Also:

• Constant Field Values

SIDEBAR_SECTION_CHAT

static final String SIDEBAR_SECTION_CHAT

See Also:

• Constant Field Values

SIDEBAR_SECTION_LIBRARY_UNOPENED

static final String SIDEBAR_SECTION_LIBRARY_UNOPENED

See Also:

• Constant Field Values

SIDEBAR_SECTION_TORRENT_DETAILS

static final String SIDEBAR_SECTION_TORRENT_DETAILS

See Also:

• Constant Field Values

SIDEBAR_SECTION_WELCOME

static final String SIDEBAR_SECTION_WELCOME

See Also:

• Constant Field Values

SIDEBAR_SECTION_SUBSCRIPTIONS

static final String SIDEBAR_SECTION_SUBSCRIPTIONS

See Also:

• Constant Field Values

SIDEBAR_SECTION_DEVICES

static final String SIDEBAR_SECTION_DEVICES

See Also:

• Constant Field Values

SIDEBAR_SECTION_DISK_OPS

static final String SIDEBAR_SECTION_DISK_OPS

See Also:

• Constant Field Values

SIDEBAR_SECTION_ACTIVITIES

static final String SIDEBAR_SECTION_ACTIVITIES

See Also:

• Constant Field Values

SIDEBAR_SECTION_SEARCH

static final String SIDEBAR_SECTION_SEARCH

See Also:

• Constant Field Values

SIDEBAR_SECTION_ALLPEERS

static final String SIDEBAR_SECTION_ALLPEERS

See Also:

• Constant Field Values

SIDEBAR_SECTION_ALLPIECES

static final String SIDEBAR_SECTION_ALLPIECES

See Also:

• Constant Field Values

SIDEBAR_SECTION_ALLBLOCKS

static final String SIDEBAR_SECTION_ALLBLOCKS

See Also:

• Constant Field Values

SIDEBAR_SECTION_TORRENT_OPTIONS

static final String SIDEBAR_SECTION_TORRENT_OPTIONS

See Also:

• Constant Field Values

SIDEBAR_SECTION_MY_SHARES

static final String SIDEBAR_SECTION_MY_SHARES

See Also:

• Constant Field Values

SIDEBAR_SECTION_MY_TRACKER

static final String SIDEBAR_SECTION_MY_TRACKER

See Also:

• Constant Field Values

SIDEBAR_SECTION_CLIENT_STATS

static final String SIDEBAR_SECTION_CLIENT_STATS

See Also:

• Constant Field Values

SIDEBAR_SECTION_LOGGER

static final String SIDEBAR_SECTION_LOGGER

See Also:

• Constant Field Values

SIDEBAR_SECTION_CONFIG

static final String SIDEBAR_SECTION_CONFIG

See Also:

• Constant Field Values

SIDEBAR_SECTION_ARCHIVED_DOWNLOADS

static final String SIDEBAR_SECTION_ARCHIVED_DOWNLOADS

See Also:

• Constant Field Values

SIDEBAR_SECTION_DOWNLOAD_HISTORY

static final String SIDEBAR_SECTION_DOWNLOAD_HISTORY

See Also:

• Constant Field Values

SIDEBAR_SECTION_ALL_TRACKERS

static final String SIDEBAR_SECTION_ALL_TRACKERS

See Also:

• Constant Field Values

SIDEBAR_SECTION_LIBRARY_CAT_INSTANCES

static final String SIDEBAR_SECTION_LIBRARY_CAT_INSTANCES

See Also:

• Constant Field Values

SIDEBAR_SECTION_LIBRARY_TAG_INSTANCES

static final String SIDEBAR_SECTION_LIBRARY_TAG_INSTANCES

See Also:

• Constant Field Values

SIDEBAR_TRANSFERS_SECTION_ORDER

static final String[] SIDEBAR_TRANSFERS_SECTION_ORDER

Method Details

showEntryByID

boolean showEntryByID(String id)

showEntryByID

boolean showEntryByID(String id,
 Object datasource)

popoutEntryByID

boolean popoutEntryByID(String id,
 Object datasource,
 Map<String,Object> options)

createEntryFromSkinRef

MdiEntry createEntryFromSkinRef(String parentEntryID,
 String id,
 String configID,
 String title,
 ViewTitleInfo titleInfo,
 Object params,
 boolean closeable,
 String preferedAfterID)

If you prefix the 'preferedAfterID' string with '~' then the operation will actually switch to 'preferedBeforeID'

Parameters:

parentEntryID -

id -

configID -

title -

titleInfo -

params -

closeable -

preferedAfterID -

Returns:

getSelectedEntry

MdiEntry getSelectedEntry()

getMenuEntry

MdiEntry getMenuEntry(boolean activeOnly)

getEntry

MdiEntry getEntry(String id)

getEntry

MdiEntry getEntry(String id,
 Object datasource)

addListener

void addListener(MdiListener l)

removeListener

void removeListener(MdiListener l)

addListener

void addListener(MdiEntryLoadedListener l)

removeListener

void removeListener(MdiEntryLoadedListener l)

isVisible

boolean isVisible()

closeEntry

void closeEntry(String id)

Deprecated.

Use closeEntryByID(String)

Close MdiEntry with id and remove from auto-open list

closeEntry

MdiEntry closeEntry(MdiEntry entry,
 boolean userInitiated)

Close MdiEntry

Parameters:

userInitiated - whether or not the user explicitly closed this view (used for the dynamic Downloading library view, for example...)

Returns:

Entry that was closed, or null if entry wasn't closed (ie. didn't exist)

closeEntryByID

MdiEntry closeEntryByID(String id)

Close MdiEntry of id

Returns:

Entry that was closed, or null if entry wasn't closed (ie. didn't exist)

getEntries

MdiEntry[] getEntries()

registerEntry

void registerEntry(String id,
 MdiEntryCreationListener l)

registerEntry

void registerEntry(String id,
 MdiEntryCreationListener2 mdiEntryCreationListener2)

deregisterEntry

void deregisterEntry(String id,
 MdiEntryCreationListener l)

deregisterEntry

void deregisterEntry(String id,
 MdiEntryCreationListener2 mdiEntryCreationListener2)

entryExists

boolean entryExists(String id)

removeItem

void removeItem(MdiEntry entry)

setEntryAutoOpen

void setEntryAutoOpen(String id,
 Map autoOpenInfo)

When an entry can not be opened (ie. creation listener isn't registered yet), call this to store your open request

removeEntryAutoOpen

void removeEntryAutoOpen(String id)

willEntryAutoOpen

boolean willEntryAutoOpen(String id)

showEntry

void showEntry(MdiEntry newEntry)

loadEntryByID

boolean loadEntryByID(String id,
 boolean activate)

setPreferredOrder

void setPreferredOrder(String[] preferredOrder)

getPreferredOrder

String[] getPreferredOrder()

createHeader

MdiEntry createHeader(String id,
 String title,
 String preferredAfterID)

getChildrenOf

List<MdiEntry> getChildrenOf(String id)

loadEntryByID

boolean loadEntryByID(String id,
 boolean activate,
 boolean onlyLoadOnce,
 Object datasource)

getEntriesCount

int getEntriesCount()

Returns:

Since:

5.6.0.1

isInitialized

boolean isInitialized()

setDefaultEntryID

void setDefaultEntryID(String def)

isDisposed

boolean isDisposed()

getViewID

String getViewID()

getDataSourceType

Class getDataSourceType()

runWhenIdle

void runWhenIdle(Runnable r)