Class BaseMDI

java.lang.Object

com.biglybt.ui.swt.skin.SWTSkinObjectAdapter

com.biglybt.ui.swt.views.skin.SkinView

com.biglybt.ui.swt.mdi.BaseMDI

All Implemented Interfaces:

UIUpdatable, MultipleDocumentInterface, MultipleDocumentInterfaceSWT, SWTSkinObjectListener

Direct Known Subclasses:

SideBar, TabbedMDI

public abstract class BaseMDI
extends SkinView
implements MultipleDocumentInterfaceSWT, UIUpdatable

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AUTOOPENINFO_DS
static final String	AUTOOPENINFO_PARENTID
static final String	AUTOOPENINFO_TITLE
private final Object	autoOpenLock
private TimerEvent	autoOpenSaver
static final String	CLOSEABLECONFIG_INITIALID
private String	closeableConfigFile
private boolean	closed
private MdiEntrySWT	currentEntry
private String	initialDef
private String	initialID
private boolean	initialized
private String	lastValidViewID
private final List<MdiListener>	listeners
private final List<MdiEntryLoadedListener>	listLoadListeners
private List<MdiSWTMenuHackListener>	listMenuHackListners
private LinkedHashMap<String,Map>	mapAutoOpen	mapAutoOpen: Map<ViewID, AutoOpenInfo> AutoOpenInfo: Map<String, Object> "title" : String "datasource" : misc "parentID" : String
private boolean	mapAutoOpenLoaded
private Map<String, MdiEntryCreationListener>	mapIdToCreationListener
private Map<String, MdiEntryCreationListener2>	mapIdToCreationListener2
private final Map<String, BaseMdiEntry>	mapIdToEntry
private final UISWTView	parentView
private final Class<?>	pluginDataSourceType
private String[]	preferredOrder
private UISWTInstanceImpl.SWTViewListener	swtViewListener
private final String	viewID

Fields inherited from class SkinView

skin, soMain

Fields inherited from interface MultipleDocumentInterface

SIDEBAR_HEADER_DASHBOARD, SIDEBAR_HEADER_DEVICES, SIDEBAR_HEADER_DISCOVERY, SIDEBAR_HEADER_ORDER_DEFAULT, SIDEBAR_HEADER_PLUGINS, SIDEBAR_HEADER_TRANSFERS, SIDEBAR_HEADER_VUZE, SIDEBAR_POS_FIRST, SIDEBAR_SECTION_ACTIVITIES, SIDEBAR_SECTION_ALL_TRACKERS, SIDEBAR_SECTION_ALLBLOCKS, SIDEBAR_SECTION_ALLPEERS, SIDEBAR_SECTION_ALLPIECES, SIDEBAR_SECTION_ARCHIVED_DOWNLOADS, SIDEBAR_SECTION_BETAPROGRAM, SIDEBAR_SECTION_CHAT, SIDEBAR_SECTION_CLIENT_STATS, SIDEBAR_SECTION_CONFIG, SIDEBAR_SECTION_DEVICES, SIDEBAR_SECTION_DISK_OPS, SIDEBAR_SECTION_DOWNLOAD_HISTORY, SIDEBAR_SECTION_LIBRARY, SIDEBAR_SECTION_LIBRARY_CAT_INSTANCES, SIDEBAR_SECTION_LIBRARY_CD, SIDEBAR_SECTION_LIBRARY_DL, SIDEBAR_SECTION_LIBRARY_TAG_INSTANCES, SIDEBAR_SECTION_LIBRARY_UNOPENED, SIDEBAR_SECTION_LOGGER, SIDEBAR_SECTION_MY_SHARES, SIDEBAR_SECTION_MY_TRACKER, SIDEBAR_SECTION_PLUGINS, SIDEBAR_SECTION_SEARCH, SIDEBAR_SECTION_SUBSCRIPTIONS, SIDEBAR_SECTION_TAG_DISCOVERY, SIDEBAR_SECTION_TAGS, SIDEBAR_SECTION_TORRENT_DETAILS, SIDEBAR_SECTION_TORRENT_OPTIONS, SIDEBAR_SECTION_WELCOME, SIDEBAR_TRANSFERS_SECTION_ORDER

Fields inherited from interface SWTSkinObjectListener

EVENT_CREATE_REQUEST, EVENT_CREATED, EVENT_DATASOURCE_CHANGED, EVENT_DESTROY, EVENT_HIDE, EVENT_LANGUAGE_CHANGE, EVENT_OBFUSCATE, EVENT_SELECT, EVENT_SHOW, NAMES

Constructor Summary

Constructors

Constructor	Description
BaseMDI(Class<?> pluginDataSourceType, String viewID, UISWTView parentView)

Method Summary

Modifier and Type	Method	Description
void	addItem(BaseMdiEntry entry)
void	addListener(MdiEntryLoadedListener l)
void	addListener(MdiListener l)
void	addListener(MdiSWTMenuHackListener l)
private void	autoOpenUpdated()
private boolean	canCreateEntryByCreationListener(String id)
boolean	canShowEntryByID(String id)
final BaseMdiEntry	closeEntry(MdiEntry entry, boolean userInitiated)	Close MdiEntry
final void	closeEntry(String id)	Close MdiEntry with id and remove from auto-open list
BaseMdiEntry	closeEntryByID(String id)	Close MdiEntry of id
protected BaseMdiEntry	closeEntryByID(String id, boolean userInitiated)
protected MdiEntry	createEntryByCreationListener(String id, Map<?,?> autoOpenInfo)
final MdiEntry	createEntryFromEventListener(String parentID, UISWTViewEventListener l, String id, boolean closeable, Object datasource, String preferedAfterID)	Deprecated. Use createEntryFromHolder(parentEntryID, null, new UISWTViewEventListenerHolder(id, l, datasource, null), id, closeable, preferedAfterID);
abstract 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'
private boolean	createIfAutoOpen(String id)
void	deregisterEntry(String id, MdiEntryCreationListener l)
void	deregisterEntry(String id, MdiEntryCreationListener2 l)
boolean	entryExists(String id)
void	fillMenu(org.eclipse.swt.widgets.Menu menu, MdiEntry entry, String menuID)
List<MdiEntry>	getChildrenOf(String id)
Class	getDataSourceType()
MdiEntrySWT[]	getEntries()
<T extends MdiEntry> T[]	getEntries(T[] array)
int	getEntriesCount()
MdiEntrySWT	getEntry(String id)
MdiEntry	getEntry(String id, Object datasource)
MdiEntrySWT	getEntryBySkinView(Object skinView)
static BaseMdiEntry	getEntryFromSkinObject(PluginUISWTSkinObject pluginSkinObject)
MdiSWTMenuHackListener[]	getMenuHackListeners()
String	getMenuIdPrefix()
UISWTView	getParentView()
String[]	getPreferredOrder()
MdiEntrySWT	getSelectedEntry()
protected String	getShowIDAtStartup()
String	getUpdateUIName()	A name for this UIUpdatable so we can track who's being bad
String	getViewID()
boolean	isInitialized()
protected void	itemSelected(MdiEntry entry)
private MdiEntry	loadAndGetEntryByID(String id, boolean activate, boolean onlyLoadOnce, Object datasource)
private void	loadCloseables()
boolean	loadEntryByID(String id, boolean activate)
boolean	loadEntryByID(String id, boolean activate, boolean onlyLoadOnce, Object datasource)
abstract boolean	popoutEntry(MdiEntry entry, Map<String,Object> options)
boolean	popoutEntryByID(String id, Object datasource, Map<String,Object> options)
private boolean	processAutoOpenMap(String id, Map<?,?> autoOpenInfo, UISWTViewBuilderCore builder)
void	registerEntry(String id, MdiEntryCreationListener l)
void	registerEntry(String id, MdiEntryCreationListener2 l)
private void	removeChildrenOf(String id)
void	removeEntryAutoOpen(String id)
void	removeItem(MdiEntry entry)
protected void	removeItem(MdiEntry entry, boolean removeChildren)
void	removeListener(MdiEntryLoadedListener l)
void	removeListener(MdiListener l)
void	removeListener(MdiSWTMenuHackListener l)
protected void	saveCloseables()
private void	saveCloseables(boolean interim)
void	setCloseableConfigFile(String closeableConfigFile)
void	setDefaultEntryID(String def)
void	setEntryAutoOpen(String id, Map autoOpenInfo)	When an entry can not be opened (ie.
protected abstract void	setEntryLoadedOnce(String id)
void	setPreferredOrder(String[] preferredOrder)
protected void	setSelectedEntry(MdiEntrySWT entry)
protected void	setupPluginViews()
boolean	showEntryByID(String id)
boolean	showEntryByID(String id, Object datasource)
Object	skinObjectDestroyed(SWTSkinObject skinObject, Object params)	Skin Object was destroyed
Object	skinObjectInitialShow(SWTSkinObject skinObject, Object params)
void	triggerEntryLoadedListeners(MdiEntry entry)
protected void	triggerSelectionListener(MdiEntry newEntry, MdiEntry oldEntry)
Object	updateLanguage(SWTSkinObject skinObject, Object params)	skinObject needs to update any text
void	updateUI()	Update your UI!
protected abstract boolean	wasEntryLoadedOnce(String id)
boolean	willEntryAutoOpen(String id)

Methods inherited from class SkinView

getMainSkinObject, getMdiEntry, getSkin, getSkinObject, isDisposed, isVisible, setMainSkinObject, skinObjectCreated, skinObjectHidden, skinObjectShown

Methods inherited from class SWTSkinObjectAdapter

dataSourceChanged, eventOccured, skinObjectSelected

Methods inherited from class Object

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

Methods inherited from interface MultipleDocumentInterface

createHeader, getMenuEntry, isDisposed, isVisible, runWhenIdle, showEntry

Methods inherited from interface MultipleDocumentInterfaceSWT

buildMDI, buildMDI, createEntry

Field Details

CLOSEABLECONFIG_INITIALID

public static final String CLOSEABLECONFIG_INITIALID

See Also:

• Constant Field Values

pluginDataSourceType

private final Class<?> pluginDataSourceType

viewID

private final String viewID

parentView

private final UISWTView parentView

currentEntry

private MdiEntrySWT currentEntry

mapIdToCreationListener

private Map<String, MdiEntryCreationListener> mapIdToCreationListener

mapIdToCreationListener2

private Map<String, MdiEntryCreationListener2> mapIdToCreationListener2

mapIdToEntry

private final Map<String, BaseMdiEntry> mapIdToEntry

listeners

private final List<MdiListener> listeners

listLoadListeners

private final List<MdiEntryLoadedListener> listLoadListeners

listMenuHackListners

private List<MdiSWTMenuHackListener> listMenuHackListners

autoOpenLock

private final Object autoOpenLock

AUTOOPENINFO_TITLE

public static final String AUTOOPENINFO_TITLE

See Also:

• Constant Field Values

AUTOOPENINFO_DS

public static final String AUTOOPENINFO_DS

See Also:

• Constant Field Values

AUTOOPENINFO_PARENTID

public static final String AUTOOPENINFO_PARENTID

See Also:

• Constant Field Values

mapAutoOpen

private LinkedHashMap<String,Map> mapAutoOpen

mapAutoOpen: Map<ViewID, AutoOpenInfo>
AutoOpenInfo: Map<String, Object>
  "title" : String
  "datasource" : misc
  "parentID" : String

mapAutoOpenLoaded

private volatile boolean mapAutoOpenLoaded

autoOpenSaver

private TimerEvent autoOpenSaver

preferredOrder

private String[] preferredOrder

closeableConfigFile

private String closeableConfigFile

swtViewListener

private UISWTInstanceImpl.SWTViewListener swtViewListener

initialized

private volatile boolean initialized

closed

private volatile boolean closed

lastValidViewID

private String lastValidViewID

initialID

private String initialID

initialDef

private volatile String initialDef

Constructor Details

BaseMDI

public BaseMDI(Class<?> pluginDataSourceType,
 String viewID,
 UISWTView parentView)

Method Details

addListener

public void addListener(MdiListener l)

Specified by:

addListener in interface MultipleDocumentInterface

removeListener

public void removeListener(MdiListener l)

Specified by:

removeListener in interface MultipleDocumentInterface

addListener

public void addListener(MdiEntryLoadedListener l)

Specified by:

addListener in interface MultipleDocumentInterface

removeListener

public void removeListener(MdiEntryLoadedListener l)

Specified by:

removeListener in interface MultipleDocumentInterface

triggerSelectionListener

protected void triggerSelectionListener(MdiEntry newEntry,
 MdiEntry oldEntry)

triggerEntryLoadedListeners

public void triggerEntryLoadedListeners(MdiEntry entry)

closeEntry

public final void closeEntry(String id)

Description copied from interface: MultipleDocumentInterface

Close MdiEntry with id and remove from auto-open list

Specified by:

closeEntry in interface MultipleDocumentInterface

closeEntry

public final BaseMdiEntry closeEntry(MdiEntry entry,
 boolean userInitiated)

Description copied from interface: MultipleDocumentInterface

Close MdiEntry

Specified by:

closeEntry in interface MultipleDocumentInterface

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

public BaseMdiEntry closeEntryByID(String id)

Description copied from interface: MultipleDocumentInterface

Close MdiEntry of id

Specified by:

closeEntryByID in interface MultipleDocumentInterface

Returns:

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

closeEntryByID

protected BaseMdiEntry closeEntryByID(String id,
 boolean userInitiated)

getMenuIdPrefix

public String getMenuIdPrefix()

createEntryFromEventListener

public final MdiEntry createEntryFromEventListener(String parentID,
 UISWTViewEventListener l,
 String id,
 boolean closeable,
 Object datasource,
 String preferedAfterID)

Deprecated.

Use createEntryFromHolder(parentEntryID, null, new UISWTViewEventListenerHolder(id, l, datasource, null), id, closeable, preferedAfterID);

Specified by:

createEntryFromEventListener in interface MultipleDocumentInterfaceSWT

createEntryFromSkinRef

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

Description copied from interface: MultipleDocumentInterface

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

Specified by:

createEntryFromSkinRef in interface MultipleDocumentInterface

Parameters:

parentEntryID -

id -

configID -

title -

titleInfo -

params -

closeable -

preferedAfterID -

Returns:

getSelectedEntry

public MdiEntrySWT getSelectedEntry()

Specified by:

getSelectedEntry in interface MultipleDocumentInterface

Specified by:

getSelectedEntry in interface MultipleDocumentInterfaceSWT

setSelectedEntry

protected void setSelectedEntry(MdiEntrySWT entry)

getEntries

public MdiEntrySWT[] getEntries()

Specified by:

getEntries in interface MultipleDocumentInterface

Specified by:

getEntries in interface MultipleDocumentInterfaceSWT

getEntries

public <T extends MdiEntry> T[] getEntries(T[] array)

getEntry

public MdiEntrySWT getEntry(String id)

Specified by:

getEntry in interface MultipleDocumentInterface

Specified by:

getEntry in interface MultipleDocumentInterfaceSWT

getEntry

public MdiEntry getEntry(String id,
 Object datasource)

Specified by:

getEntry in interface MultipleDocumentInterface

getEntryBySkinView

public MdiEntrySWT getEntryBySkinView(Object skinView)

Specified by:

getEntryBySkinView in interface MultipleDocumentInterfaceSWT

Parameters:

skinView -

Returns:

Since:

3.1.1.1

getUpdateUIName

public String getUpdateUIName()

Description copied from interface: UIUpdatable

A name for this UIUpdatable so we can track who's being bad

Specified by:

getUpdateUIName in interface UIUpdatable

Returns:

some name

registerEntry

public void registerEntry(String id,
 MdiEntryCreationListener2 l)

Specified by:

registerEntry in interface MultipleDocumentInterface

deregisterEntry

public void deregisterEntry(String id,
 MdiEntryCreationListener2 l)

Specified by:

deregisterEntry in interface MultipleDocumentInterface

createIfAutoOpen

private boolean createIfAutoOpen(String id)

canCreateEntryByCreationListener

private boolean canCreateEntryByCreationListener(String id)

createEntryByCreationListener

protected MdiEntry createEntryByCreationListener(String id,
 Map<?,?> autoOpenInfo)

registerEntry

public void registerEntry(String id,
 MdiEntryCreationListener l)

Specified by:

registerEntry in interface MultipleDocumentInterface

deregisterEntry

public void deregisterEntry(String id,
 MdiEntryCreationListener l)

Specified by:

deregisterEntry in interface MultipleDocumentInterface

showEntryByID

public boolean showEntryByID(String id)

Specified by:

showEntryByID in interface MultipleDocumentInterface

canShowEntryByID

public boolean canShowEntryByID(String id)

showEntryByID

public boolean showEntryByID(String id,
 Object datasource)

Specified by:

showEntryByID in interface MultipleDocumentInterface

popoutEntryByID

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

Specified by:

popoutEntryByID in interface MultipleDocumentInterface

popoutEntry

public abstract boolean popoutEntry(MdiEntry entry,
 Map<String,Object> options)

skinObjectInitialShow

public Object skinObjectInitialShow(SWTSkinObject skinObject,
 Object params)

Specified by:

skinObjectInitialShow in class SkinView

Parameters:

skinObject -

params -

Returns:

skinObjectDestroyed

public Object skinObjectDestroyed(SWTSkinObject skinObject,
 Object params)

Description copied from class: SWTSkinObjectAdapter

Skin Object was destroyed

Overrides:

skinObjectDestroyed in class SkinView

updateUI

public void updateUI()

Description copied from interface: UIUpdatable

Update your UI!

Specified by:

updateUI in interface UIUpdatable

loadEntryByID

public boolean loadEntryByID(String id,
 boolean activate)

Specified by:

loadEntryByID in interface MultipleDocumentInterface

loadEntryByID

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

Specified by:

loadEntryByID in interface MultipleDocumentInterface

loadAndGetEntryByID

private MdiEntry loadAndGetEntryByID(String id,
 boolean activate,
 boolean onlyLoadOnce,
 Object datasource)

setEntryLoadedOnce

protected abstract void setEntryLoadedOnce(String id)

wasEntryLoadedOnce

protected abstract boolean wasEntryLoadedOnce(String id)

entryExists

public boolean entryExists(String id)

Specified by:

entryExists in interface MultipleDocumentInterface

setDefaultEntryID

public void setDefaultEntryID(String def)

Specified by:

setDefaultEntryID in interface MultipleDocumentInterface

setEntryAutoOpen

public void setEntryAutoOpen(String id,
 Map autoOpenInfo)

Description copied from interface: MultipleDocumentInterface

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

Specified by:

setEntryAutoOpen in interface MultipleDocumentInterface

removeEntryAutoOpen

public void removeEntryAutoOpen(String id)

Specified by:

removeEntryAutoOpen in interface MultipleDocumentInterface

willEntryAutoOpen

public boolean willEntryAutoOpen(String id)

Specified by:

willEntryAutoOpen in interface MultipleDocumentInterface

autoOpenUpdated

private void autoOpenUpdated()

setupPluginViews

protected void setupPluginViews()

loadCloseables

private void loadCloseables()

getShowIDAtStartup

protected String getShowIDAtStartup()

saveCloseables

protected void saveCloseables()

saveCloseables

private void saveCloseables(boolean interim)

processAutoOpenMap

private boolean processAutoOpenMap(String id,
 Map<?,?> autoOpenInfo,
 UISWTViewBuilderCore builder)

addItem

public void addItem(BaseMdiEntry entry)

itemSelected

protected void itemSelected(MdiEntry entry)

removeItem

public void removeItem(MdiEntry entry)

Specified by:

removeItem in interface MultipleDocumentInterface

removeItem

protected void removeItem(MdiEntry entry,
 boolean removeChildren)

removeChildrenOf

private void removeChildrenOf(String id)

getChildrenOf

public List<MdiEntry> getChildrenOf(String id)

Specified by:

getChildrenOf in interface MultipleDocumentInterface

updateLanguage

public Object updateLanguage(SWTSkinObject skinObject,
 Object params)

Description copied from class: SWTSkinObjectAdapter

skinObject needs to update any text

Overrides:

updateLanguage in class SWTSkinObjectAdapter

setPreferredOrder

public void setPreferredOrder(String[] preferredOrder)

Specified by:

setPreferredOrder in interface MultipleDocumentInterface

getPreferredOrder

public String[] getPreferredOrder()

Specified by:

getPreferredOrder in interface MultipleDocumentInterface

getEntriesCount

public int getEntriesCount()

Specified by:

getEntriesCount in interface MultipleDocumentInterface

Returns:

setCloseableConfigFile

public void setCloseableConfigFile(String closeableConfigFile)

Specified by:

setCloseableConfigFile in interface MultipleDocumentInterfaceSWT

Parameters:

closeableConfigFile -

addListener

public void addListener(MdiSWTMenuHackListener l)

removeListener

public void removeListener(MdiSWTMenuHackListener l)

getMenuHackListeners

public MdiSWTMenuHackListener[] getMenuHackListeners()

fillMenu

public void fillMenu(org.eclipse.swt.widgets.Menu menu,
 MdiEntry entry,
 String menuID)

isInitialized

public boolean isInitialized()

Specified by:

isInitialized in interface MultipleDocumentInterface

getEntryFromSkinObject

public static BaseMdiEntry getEntryFromSkinObject(PluginUISWTSkinObject pluginSkinObject)

getParentView

public UISWTView getParentView()

getViewID

public String getViewID()

Specified by:

getViewID in interface MultipleDocumentInterface

getDataSourceType

public Class getDataSourceType()

Specified by:

getDataSourceType in interface MultipleDocumentInterface