Class TabbedMDI

java.lang.Object

com.biglybt.ui.swt.skin.SWTSkinObjectAdapter

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

com.biglybt.ui.swt.mdi.BaseMDI

com.biglybt.ui.swt.mdi.TabbedMDI

All Implemented Interfaces:

ParameterListener, AEDiagnosticsEvidenceGenerator, UIUpdatable, MultipleDocumentInterface, ObfuscateImage, MultipleDocumentInterfaceSWT, TabbedMdiInterface, SWTSkinObjectListener

public class TabbedMDI
extends BaseMDI
implements TabbedMdiInterface, AEDiagnosticsEvidenceGenerator, ParameterListener, ObfuscateImage

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	allowSubViews
private Object	dataSource
private boolean	destroyEntriesOnDeactivate
private int	iFolderHeightAdj
protected boolean	isMainMDI
private static final String	KEY_AUTO_CLOSE
private Map	mapUserClosedTabs
private TabbedMdiMaximizeListener	maximizeListener
private boolean	maximizeVisible
protected boolean	minimized
private boolean	minimizeVisible
private int	minimumCharacters
private ParameterListener	paramFancyTabListener
private final String	props_prefix
private LinkedList<TabbedEntry>	select_history
private org.eclipse.swt.custom.CTabFolder	tabFolder
private TabFolderRenderer	tabFolderRenderer
private org.eclipse.swt.widgets.Composite	topRight

Fields inherited from class BaseMDI

AUTOOPENINFO_DS, AUTOOPENINFO_PARENTID, AUTOOPENINFO_TITLE, CLOSEABLECONFIG_INITIALID

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
TabbedMDI()
TabbedMDI(Class<?> pluginDataSourceType, String viewID, String props_prefix, UISWTView parentView, Object dataSource)

Method Summary

Modifier and Type	Method	Description
private void	addDragDropListeners()
private void	addMenus(TabbedEntry entry, String id)
void	buildMDI(SWTSkinObject skinObject)
void	buildMDI(org.eclipse.swt.widgets.Composite parent)	Builds MDI and populates it with entries registered to id or datasourcetype
private void	buildTabs()
protected BaseMdiEntry	closeEntryByID(String id, boolean userInitiated)
TabbedEntry	createEntry(UISWTViewBuilderCore builder, boolean closeable)
protected MdiEntry	createEntryByCreationListener(String id, Map<?,?> autoOpenInfo)
private TabbedEntry	createEntryFromSkinRef(String id, String configID, String title, ViewTitleInfo titleInfo, Object params, boolean closeable, String preferredAfterID)
TabbedEntry	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'
TabbedEntry	createHeader(String id, String title, String preferredAfterID)
private void	creatMDI()
void	fillMenu(org.eclipse.swt.widgets.Menu menu, MdiEntry entry, String menuID)
void	generate(IndentWriter writer)
boolean	getAllowSubViews()	Whether this MDI wants subviews.
TabbedEntry	getEntry(String id)
TabbedEntry	getEntryBySkinView(Object skinView)
protected TabbedEntry	getEntryFromTabItem(org.eclipse.swt.custom.CTabItem item)
int	getFolderHeight()
TabbedEntry	getMenuEntry(boolean activeOnly)
String	getMenuIdPrefix()
boolean	getMinimized()
private TabbedEntry	getPrevious(TabbedEntry current)
TabFolderRenderer	getRenderer()
TabbedEntry	getSelectedEntry()
org.eclipse.swt.custom.CTabFolder	getTabFolder()
String	getUpdateUIName()	A name for this UIUpdatable so we can track who's being bad
private String	getViewTitleID(String view_id)
private MdiEntryVitalityImageSWT	getVitalityImageAtPos(int x, int y)
private int	indexOf(MdiEntry entry)
private int	indexOf(String viewID)
boolean	isEmpty()
private boolean	isEntryClosedByUser(String id)
private void	minimize()
org.eclipse.swt.graphics.Image	obfuscatedImage(org.eclipse.swt.graphics.Image image)
void	parameterChanged(String parameterName)	Called, when a parameter has changed.
boolean	popoutEntry(MdiEntry entry, Map<String,Object> options)
private void	restore()
void	runWhenIdle(Runnable r)
private void	selectNextTab(boolean selectNext)
void	setAllowSubViews(boolean allowSubViews)	Sets whether this MDI wants subviews.
void	setDestroyEntriesOnDeactivate(boolean destroyEntriesOnDeactivate)
void	setEntriesDataSource(Object newDataSource)
protected void	setEntryLoadedOnce(String id)
void	setMaximizeVisible(boolean visible)
void	setMinimized(boolean minimized)
void	setMinimizeVisible(boolean visible)
protected void	setSelectedEntry(MdiEntrySWT entry)
void	setTabbedMdiMaximizeListener(TabbedMdiMaximizeListener l)
private void	setupNewEntry(TabbedEntry entry)
void	showEntry(MdiEntry _newEntry)
Object	skinObjectCreated(SWTSkinObject skinObject, Object params)	Skin Object was created.
Object	skinObjectDestroyed(SWTSkinObject skinObject, Object params)	Skin Object was destroyed
protected void	swt_refreshVitality()
private void	swt_setupNewEntry(TabbedEntry entry)
void	updateUI()	Update your UI!
protected boolean	wasEntryLoadedOnce(String id)

Methods inherited from class BaseMDI

addItem, addListener, addListener, addListener, canShowEntryByID, closeEntry, closeEntry, closeEntryByID, createEntryFromEventListener, deregisterEntry, deregisterEntry, entryExists, getChildrenOf, getDataSourceType, getEntries, getEntries, getEntriesCount, getEntry, getEntryFromSkinObject, getMenuHackListeners, getParentView, getPreferredOrder, getShowIDAtStartup, getViewID, isInitialized, itemSelected, loadEntryByID, loadEntryByID, popoutEntryByID, registerEntry, registerEntry, removeEntryAutoOpen, removeItem, removeItem, removeListener, removeListener, removeListener, saveCloseables, setCloseableConfigFile, setDefaultEntryID, setEntryAutoOpen, setPreferredOrder, setupPluginViews, showEntryByID, showEntryByID, skinObjectInitialShow, triggerEntryLoadedListeners, triggerSelectionListener, updateLanguage, willEntryAutoOpen

Methods inherited from class SkinView

getMainSkinObject, getMdiEntry, getSkin, getSkinObject, isDisposed, isVisible, setMainSkinObject, 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

addListener, addListener, closeEntry, closeEntry, closeEntryByID, deregisterEntry, deregisterEntry, entryExists, getChildrenOf, getDataSourceType, getEntriesCount, getEntry, getPreferredOrder, getViewID, isDisposed, isInitialized, isVisible, loadEntryByID, loadEntryByID, popoutEntryByID, registerEntry, registerEntry, removeEntryAutoOpen, removeItem, removeListener, removeListener, setDefaultEntryID, setEntryAutoOpen, setPreferredOrder, showEntryByID, showEntryByID, willEntryAutoOpen

Methods inherited from interface MultipleDocumentInterfaceSWT

createEntryFromEventListener, getEntries, setCloseableConfigFile

Methods inherited from interface TabbedMdiInterface

addListener

Field Details

KEY_AUTO_CLOSE

private static final String KEY_AUTO_CLOSE

See Also:

• Constant Field Values

tabFolder

private org.eclipse.swt.custom.CTabFolder tabFolder

tabFolderRenderer

private TabFolderRenderer tabFolderRenderer

select_history

private LinkedList<TabbedEntry> select_history

minimized

protected boolean minimized

iFolderHeightAdj

private int iFolderHeightAdj

props_prefix

private final String props_prefix

minimumCharacters

private int minimumCharacters

isMainMDI

protected boolean isMainMDI

mapUserClosedTabs

private Map mapUserClosedTabs

maximizeVisible

private boolean maximizeVisible

minimizeVisible

private boolean minimizeVisible

maximizeListener

private TabbedMdiMaximizeListener maximizeListener

paramFancyTabListener

private ParameterListener paramFancyTabListener

topRight

private org.eclipse.swt.widgets.Composite topRight

destroyEntriesOnDeactivate

private boolean destroyEntriesOnDeactivate

dataSource

private Object dataSource

allowSubViews

private boolean allowSubViews

Constructor Details

TabbedMDI

public TabbedMDI()

TabbedMDI

public TabbedMDI(Class<?> pluginDataSourceType,
 String viewID,
 String props_prefix,
 UISWTView parentView,
 Object dataSource)

Parameters:

pluginDataSourceType - Only needed if every tab is based on the same datasource, such as Download

viewID - ID used to register views against this MDI

props_prefix - Prefix for loading MDIs properties (open history, etc)
Also used to get registered menu items. So, should be one of MENU_ constants in MenuManager

parentView - This MDI's parent. For example, Parent=(Torrent's Peers View), this=(MDI showing Piece Map, Files, etc)

dataSource - DataSource to pass into each new entry. If null, entry's initial datasource will be used.

parent - SWT Composite to place widgets on

Method Details

buildMDI

public void buildMDI(org.eclipse.swt.widgets.Composite parent)

Description copied from interface: MultipleDocumentInterfaceSWT

Builds MDI and populates it with entries registered to id or datasourcetype

Specified by:

buildMDI in interface MultipleDocumentInterfaceSWT

Parameters:

parent -

buildMDI

public void buildMDI(SWTSkinObject skinObject)

Specified by:

buildMDI in interface MultipleDocumentInterfaceSWT

skinObjectCreated

public Object skinObjectCreated(SWTSkinObject skinObject,
 Object params)

Description copied from class: SWTSkinObjectAdapter

Skin Object was created. All children are guaranteed to be created.

Overrides:

skinObjectCreated in class SkinView

skinObjectDestroyed

public Object skinObjectDestroyed(SWTSkinObject skinObject,
 Object params)

Description copied from class: SWTSkinObjectAdapter

Skin Object was destroyed

Overrides:

skinObjectDestroyed in class BaseMDI

creatMDI

private void creatMDI()

addDragDropListeners

private void addDragDropListeners()

buildTabs

private void buildTabs()

getVitalityImageAtPos

private MdiEntryVitalityImageSWT getVitalityImageAtPos(int x,
 int y)

getViewTitleID

private String getViewTitleID(String view_id)

minimize

private void minimize()

restore

private void restore()

selectNextTab

private void selectNextTab(boolean selectNext)

wasEntryLoadedOnce

protected boolean wasEntryLoadedOnce(String id)

Specified by:

wasEntryLoadedOnce in class BaseMDI

setEntryLoadedOnce

protected void setEntryLoadedOnce(String id)

Specified by:

setEntryLoadedOnce in class BaseMDI

getPrevious

private TabbedEntry getPrevious(TabbedEntry current)

showEntry

public void showEntry(MdiEntry _newEntry)

Specified by:

showEntry in interface MultipleDocumentInterface

createEntryFromSkinRef

private TabbedEntry createEntryFromSkinRef(String id,
 String configID,
 String title,
 ViewTitleInfo titleInfo,
 Object params,
 boolean closeable,
 String preferredAfterID)

createEntryFromSkinRef

public TabbedEntry 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

Specified by:

createEntryFromSkinRef in class BaseMDI

Parameters:

parentEntryID -

id -

configID -

title -

titleInfo -

params -

closeable -

preferedAfterID - Not used for Tabs

Returns:

createEntry

public TabbedEntry createEntry(UISWTViewBuilderCore builder,
 boolean closeable)

Specified by:

createEntry in interface MultipleDocumentInterfaceSWT

Returns:

Newly created MDI Entry

closeEntryByID

protected BaseMdiEntry closeEntryByID(String id,
 boolean userInitiated)

Overrides:

closeEntryByID in class BaseMDI

updateUI

public void updateUI()

Description copied from interface: UIUpdatable

Update your UI!

Specified by:

updateUI in interface TabbedMdiInterface

Specified by:

updateUI in interface UIUpdatable

Overrides:

updateUI in class BaseMDI

isEntryClosedByUser

private boolean isEntryClosedByUser(String id)

setupNewEntry

private void setupNewEntry(TabbedEntry entry)

swt_setupNewEntry

private void swt_setupNewEntry(TabbedEntry entry)

indexOf

private int indexOf(MdiEntry entry)

indexOf

private int indexOf(String viewID)

getEntryFromTabItem

protected TabbedEntry getEntryFromTabItem(org.eclipse.swt.custom.CTabItem item)

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

Overrides:

getUpdateUIName in class BaseMDI

Returns:

some name

generate

public void generate(IndentWriter writer)

Specified by:

generate in interface AEDiagnosticsEvidenceGenerator

createHeader

public TabbedEntry createHeader(String id,
 String title,
 String preferredAfterID)

Specified by:

createHeader in interface MultipleDocumentInterface

getTabFolder

public org.eclipse.swt.custom.CTabFolder getTabFolder()

Specified by:

getTabFolder in interface TabbedMdiInterface

setMaximizeVisible

public void setMaximizeVisible(boolean visible)

Specified by:

setMaximizeVisible in interface TabbedMdiInterface

setMinimizeVisible

public void setMinimizeVisible(boolean visible)

Specified by:

setMinimizeVisible in interface TabbedMdiInterface

getMinimized

public boolean getMinimized()

Specified by:

getMinimized in interface TabbedMdiInterface

setMinimized

public void setMinimized(boolean minimized)

Specified by:

setMinimized in interface TabbedMdiInterface

getRenderer

public TabFolderRenderer getRenderer()

getFolderHeight

public int getFolderHeight()

Specified by:

getFolderHeight in interface TabbedMdiInterface

parameterChanged

public void parameterChanged(String parameterName)

Description copied from interface: ParameterListener

Called, when a parameter has changed. The listener could only react if the parameter name is relevant. Or the listener can just read all parameters again.

Specified by:

parameterChanged in interface ParameterListener

Parameters:

parameterName - the name of the parameter that has changed

setTabbedMdiMaximizeListener

public void setTabbedMdiMaximizeListener(TabbedMdiMaximizeListener l)

Specified by:

setTabbedMdiMaximizeListener in interface TabbedMdiInterface

setDestroyEntriesOnDeactivate

public void setDestroyEntriesOnDeactivate(boolean destroyEntriesOnDeactivate)

Specified by:

setDestroyEntriesOnDeactivate in interface TabbedMdiInterface

setEntriesDataSource

public void setEntriesDataSource(Object newDataSource)

Specified by:

setEntriesDataSource in interface TabbedMdiInterface

setAllowSubViews

public void setAllowSubViews(boolean allowSubViews)

Description copied from interface: TabbedMdiInterface

Sets whether this MDI wants subviews. This is only a recommendation. It's up to the MdiEntry to obey what they show or don't show.

MdiEntries can check for this flag in UISWTViewEvent.TYPE_CREATE with:

UISWTView view = event.getView();
if (view instanceof TabbedEntry) {
   enable_tabs = ((TabbedEntry) view).getMDI().getAllowSubViews();
} else {
  // Not in an MDI, set enable_tabs here
}

Specified by:

setAllowSubViews in interface TabbedMdiInterface

getAllowSubViews

public boolean getAllowSubViews()

Description copied from interface: TabbedMdiInterface

Whether this MDI wants subviews. This is only a recommendation. It's up to the MdiEntry to obey what they show or don't show.

Specified by:

getAllowSubViews in interface TabbedMdiInterface

isEmpty

public boolean isEmpty()

obfuscatedImage

public org.eclipse.swt.graphics.Image obfuscatedImage(org.eclipse.swt.graphics.Image image)

Specified by:

obfuscatedImage in interface ObfuscateImage

createEntryByCreationListener

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

Overrides:

createEntryByCreationListener in class BaseMDI

addMenus

private void addMenus(TabbedEntry entry,
 String id)

popoutEntry

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

Specified by:

popoutEntry in class BaseMDI

fillMenu

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

Overrides:

fillMenu in class BaseMDI

getMenuIdPrefix

public String getMenuIdPrefix()

Overrides:

getMenuIdPrefix in class BaseMDI

setSelectedEntry

protected void setSelectedEntry(MdiEntrySWT entry)

Overrides:

setSelectedEntry in class BaseMDI

swt_refreshVitality

protected void swt_refreshVitality()

getEntry

public TabbedEntry getEntry(String id)

Specified by:

getEntry in interface MultipleDocumentInterface

Specified by:

getEntry in interface MultipleDocumentInterfaceSWT

Overrides:

getEntry in class BaseMDI

getSelectedEntry

public TabbedEntry getSelectedEntry()

Specified by:

getSelectedEntry in interface MultipleDocumentInterface

Specified by:

getSelectedEntry in interface MultipleDocumentInterfaceSWT

Overrides:

getSelectedEntry in class BaseMDI

getMenuEntry

public TabbedEntry getMenuEntry(boolean activeOnly)

Specified by:

getMenuEntry in interface MultipleDocumentInterface

getEntryBySkinView

public TabbedEntry getEntryBySkinView(Object skinView)

Specified by:

getEntryBySkinView in interface MultipleDocumentInterfaceSWT

Overrides:

getEntryBySkinView in class BaseMDI

Parameters:

skinView -

Returns:

runWhenIdle

public void runWhenIdle(Runnable r)

Specified by:

runWhenIdle in interface MultipleDocumentInterface