Class BaseMdiEntry

java.lang.Object

com.biglybt.ui.swt.pifimpl.UISWTViewImpl

com.biglybt.ui.swt.mdi.BaseMdiEntry

All Implemented Interfaces:

AEDiagnosticsEvidenceGenerator, UIToolBarActivationListener, UIToolBarEnablerBase, UIPluginView, UIPluginViewToolBarListener, MdiEntry, ObfuscateImage, MdiEntrySWT, UISWTView, UISWTViewCore

Direct Known Subclasses:

SideBarEntrySWT, TabbedEntry

public abstract class BaseMdiEntry
extends UISWTViewImpl
implements MdiEntrySWT, AEDiagnosticsEvidenceGenerator, ObfuscateImage

Field Summary

Fields

Modifier and Type	Field	Description
private static Map<String, List<Runnable>>	builder_waiters
private boolean	closeable
private boolean	collapseDisabled
private boolean	hasBeenOpened
private org.eclipse.swt.graphics.Image	imageLeft
private String	imageLeftID
private static final Set<String>	installing_pids
private Boolean	isExpanded
private long	lastUpdateUI
private List<MdiAcceleratorListener>	listAcceleratorListeners
private List<MdiChildCloseListener>	listChildCloseListeners
private List<MdiCloseListener>	listCloseListeners
private List<MdiEntryDatasourceListener>	listDatasourceListeners
private List<MdiEntryDropListener>	listDropListeners
private List<MdiSWTMenuHackListener>	listMenuHackListners
private List<MdiEntryOpenListener>	listOpenListeners
private List<MdiEntryVitalityImageSWT>	listVitalityImages
protected final BaseMDI	mdi
private String	parentEntryID	Parent MDIEntry.
private String	preferredAfterID
private String	skinRef
protected static final String	SO_ID_ENTRY_WRAPPER
private SWTSkinObject	soMaster
protected static long	uniqueNumber
private ViewTitleInfo	viewTitleInfo
private static ConcurrentHashMap<ViewTitleInfo, BaseMdiEntry>	vtiMap

Fields inherited from class UISWTViewImpl

CFG_PREFIX, composite, datasource, id, skin, skinObject

Fields inherited from interface UISWTView

CONTROLTYPE_AWT, CONTROLTYPE_SWT

Fields inherited from interface UISWTViewCore

CONTROLTYPE_SKINOBJECT, UD_STANDALONE_DATA_SOURCE

Fields inherited from interface UIToolBarActivationListener

ACTIVATIONTYPE_HELD, ACTIVATIONTYPE_NORMAL, ACTIVATIONTYPE_RIGHTCLICK

Constructor Summary

Constructors

Constructor	Description
BaseMdiEntry(BaseMDI mdi, String id)

Method Summary

Modifier and Type	Method	Description
void	addAcceleratorListener(MdiAcceleratorListener l)
void	addListener(MdiChildCloseListener l)
void	addListener(MdiCloseListener l)
void	addListener(MdiEntryDatasourceListener l)
void	addListener(MdiEntryDropListener l)
void	addListener(MdiEntryOpenListener l)
void	addListener(MdiSWTMenuHackListener l)
void	addListeners(Object objectWithListeners)
MdiEntryVitalityImageSWT	addVitalityImage(String imageID)
abstract void	build()
SWTSkinObjectContainer	buildStandAlone(SWTSkinObjectContainer soParent)
static SWTSkinObjectContainer	buildStandAlone(SWTSkinObjectContainer soParent, String skinRef, SWTSkin skin, String id, Object datasource, int controlType, UISWTViewBuilderCore originalBuilder)	Either skinRef or original_builder must be non-null
boolean	canBuildStandAlone()
boolean	canClose(boolean userInitiated)
boolean	close(boolean forceClose)	Closes this entry.
void	closeView()	Closes the view
void	closeView(boolean userInitiated)
protected void	destroyEntry(boolean userInitiated)
protected void	destroyEntryAlways()
Map<String,Object>	exportStandAlone()
void	generate(IndentWriter writer)
Map<String,Object>	getAutoOpenInfo()
Object	getDatasource()
Object	getDatasourceCore()
Object	getExportableDatasource()	Return an exportable version of the datasource.
String	getId()
org.eclipse.swt.graphics.Image	getImageLeft(String suffix)	Don't forget to releaseImageLeft(String)
String	getImageLeftID()
BaseMDI	getMDI()
MdiSWTMenuHackListener[]	getMenuHackListeners()
String	getParentID()	ID of Parent MdiEntry
String	getPreferredAfterID()
SWTSkinObject	getSkinObject()
SWTSkinObject	getSkinObjectMaster()
String	getSkinRef()
String	getTitle()
ViewTitleInfo	getViewTitleInfo()
List<MdiEntryVitalityImageSWT>	getVitalityImages()
boolean	hasDropListeners()
void	hide()
static SWTSkinObjectContainer	importStandAlone(SWTSkinObjectContainer soParent, Map<String,Object> map, Runnable callback)
boolean	isCloseable()
boolean	isExpanded()
boolean	processAccelerator(char c, int mask)
void	releaseImageLeft(String suffix)
void	removeAcceleratorListener(MdiAcceleratorListener l)
void	removeListener(MdiChildCloseListener l)
void	removeListener(MdiCloseListener l)
void	removeListener(MdiEntryDatasourceListener l)
void	removeListener(MdiEntryDropListener l)
void	removeListener(MdiEntryOpenListener l)
void	removeListener(MdiSWTMenuHackListener l)
private static void	removeViewTitleInfoListener(BaseMdiEntry entry, ViewTitleInfo vti)
void	requestAttention()
void	setCloseable(boolean closeable)
void	setDatasource(Object datasource)
void	setDefaultExpanded(boolean defaultExpanded)
void	setEventListener(UISWTViewEventListener newEventListener, UISWTViewBuilderCore builder, boolean doCreate)
void	setExpanded(boolean expanded)
void	setImageLeft(org.eclipse.swt.graphics.Image imageLeft)
void	setImageLeftID(String id)
protected void	setMasterComposite(org.eclipse.swt.widgets.Composite masterComposite)
void	setParentEntryID(String parentEntryID)	Set this entries belonging under another MdiEntry
void	setPluginSkinObject(PluginUISWTSkinObject skinObject)
void	setPreferredAfterID(String preferredAfterID)
void	setSkinObjectMaster(SWTSkinObject soMaster)
void	setSkinRef(String configID, Object params)
void	setTitle(String title)	Override the default title with a new one.
void	setTitleID(String id)
void	setViewTitleInfo(ViewTitleInfo _viewTitleInfo)
private static void	setViewTitleInfoListener(BaseMdiEntry entry, ViewTitleInfo vti)
void	show()
protected void	swt_hide()
void	triggerChildCloseListeners(MdiEntry child, boolean user)
void	triggerCloseListeners(boolean userInitiated)
void	triggerDatasourceListeners()
boolean	triggerDropListeners(Object o)
void	triggerEvent(int eventType, Object data)	Trigger an event for this view
void	triggerOpenListeners()
private static void	tryInstallPlugin(String plugin_id, String plugin_name, Runnable callback)
void	updateLanguage()
void	updateUI(boolean force)
protected void	viewTitleInfoRefresh(ViewTitleInfo titleInfoToRefresh)

Methods inherited from class UISWTViewImpl

addToolbarEnabler, buildStandAlone, create, getComposite, getControlType, getDataSource, getEventListener, getEventListenerBuilder, getFullTitle, getInitialDataSource, getParentView, getPluginInterface, getPluginSkinObject, getTitleID, getToolbarEnablers, getToolBarListener, getUserData, getViewID, getViewSubID, hasToolbarEnableers, initialize, isContentDisposed, isDelayInitializeToFirstActivate, isDestroyOnDeactivate, refreshTitle, refreshToolBarItems, removeToolbarEnabler, setControlType, setDelayInitializeToFirstActivate, setDestroyOnDeactivate, setParentView, setTitleIDSupport, setTitleSupport, setToolBarListener, setToolbarVisibility, setUseCoreDataSource, setUserData, toolBarItemActivated, triggerEventRaw, useCoreDataSource

Methods inherited from class Object

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

Methods inherited from interface MdiEntry

addToolbarEnabler, getToolbarEnablers, getUserData, isContentDisposed, isEntryDisposed, isSelectable, redraw, removeToolbarEnabler, setSelectable, setUserData

Methods inherited from interface MdiEntrySWT

redraw

Methods inherited from interface ObfuscateImage

obfuscatedImage

Methods inherited from interface UIPluginView

getToolBarListener, getViewID, setToolBarListener

Methods inherited from interface UIPluginViewToolBarListener

isActive

Methods inherited from interface UISWTView

getControlType, getInitialDataSource, getParentView, getPluginInterface, getViewSubID, isContentDisposed, isDestroyOnDeactivate, setControlType, setDestroyOnDeactivate

Methods inherited from interface UISWTViewCore

getComposite, getDataSource, getEventListener, getEventListenerBuilder, getFullTitle, getPluginSkinObject, getTitleID, getUserData, initialize, setParentView, setUseCoreDataSource, setUserData, useCoreDataSource

Field Details

vtiMap

private static ConcurrentHashMap<ViewTitleInfo, BaseMdiEntry> vtiMap

SO_ID_ENTRY_WRAPPER

protected static final String SO_ID_ENTRY_WRAPPER

See Also:

• Constant Field Values

uniqueNumber

protected static long uniqueNumber

mdi

protected final BaseMDI mdi

skinRef

private String skinRef

listCloseListeners

private List<MdiCloseListener> listCloseListeners

listChildCloseListeners

private List<MdiChildCloseListener> listChildCloseListeners

listOpenListeners

private List<MdiEntryOpenListener> listOpenListeners

listDropListeners

private List<MdiEntryDropListener> listDropListeners

listDatasourceListeners

private List<MdiEntryDatasourceListener> listDatasourceListeners

listMenuHackListners

private List<MdiSWTMenuHackListener> listMenuHackListners

listAcceleratorListeners

private List<MdiAcceleratorListener> listAcceleratorListeners

viewTitleInfo

private ViewTitleInfo viewTitleInfo

parentEntryID

private String parentEntryID

Parent MDIEntry. Doesn't mean that this view is embedded inside the parentID

closeable

private boolean closeable

isExpanded

private Boolean isExpanded

imageLeftID

private String imageLeftID

imageLeft

private org.eclipse.swt.graphics.Image imageLeft

collapseDisabled

private boolean collapseDisabled

soMaster

private SWTSkinObject soMaster

preferredAfterID

private String preferredAfterID

hasBeenOpened

private boolean hasBeenOpened

listVitalityImages

private List<MdiEntryVitalityImageSWT> listVitalityImages

lastUpdateUI

private long lastUpdateUI

installing_pids

private static final Set<String> installing_pids

builder_waiters

private static Map<String, List<Runnable>> builder_waiters

Constructor Details

BaseMdiEntry

public BaseMdiEntry(BaseMDI mdi,
 String id)

Method Details

setViewTitleInfoListener

private static void setViewTitleInfoListener(BaseMdiEntry entry,
 ViewTitleInfo vti)

removeViewTitleInfoListener

private static void removeViewTitleInfoListener(BaseMdiEntry entry,
 ViewTitleInfo vti)

getId

public String getId()

Specified by:

getId in interface MdiEntry

addVitalityImage

public MdiEntryVitalityImageSWT addVitalityImage(String imageID)

Specified by:

addVitalityImage in interface MdiEntry

getVitalityImages

public List<MdiEntryVitalityImageSWT> getVitalityImages()

Specified by:

getVitalityImages in interface MdiEntry

canClose

public boolean canClose(boolean userInitiated)

close

public boolean close(boolean forceClose)

Description copied from interface: MdiEntry

Closes this entry. Disposes this entry and its contents.

Specified by:

close in interface MdiEntry

Parameters:

forceClose - Some views may cancel a close (upon user request). If true, the cancel attempts will be ignored, ensuring view will be closed.

closeView

public void closeView()

Description copied from interface: UIPluginView

Closes the view

Specified by:

closeView in interface MdiEntry

Specified by:

closeView in interface UIPluginView

Overrides:

closeView in class UISWTViewImpl

closeView

public void closeView(boolean userInitiated)

destroyEntry

protected void destroyEntry(boolean userInitiated)

destroyEntryAlways

protected void destroyEntryAlways()

getDatasourceCore

public Object getDatasourceCore()

getExportableDatasource

public Object getExportableDatasource()

Description copied from interface: MdiEntry

Return an exportable version of the datasource. Usually String, but can be Map and List

Specified by:

getExportableDatasource in interface MdiEntry

getDatasource

public Object getDatasource()

Specified by:

getDatasource in interface MdiEntry

getMDI

public BaseMDI getMDI()

Specified by:

getMDI in interface MdiEntry

getParentID

public String getParentID()

Description copied from interface: MdiEntry

ID of Parent MdiEntry

Specified by:

getParentID in interface MdiEntry

setParentEntryID

public void setParentEntryID(String parentEntryID)

Description copied from interface: MdiEntry

Set this entries belonging under another MdiEntry

Specified by:

setParentEntryID in interface MdiEntry

Parameters:

parentEntryID - Parent Entry ID to place under (if MDI supports it)

isCloseable

public boolean isCloseable()

Specified by:

isCloseable in interface MdiEntry

addListeners

public void addListeners(Object objectWithListeners)

Specified by:

addListeners in interface MdiEntry

addListener

public void addListener(MdiCloseListener l)

Specified by:

addListener in interface MdiEntry

Parameters:

l -

removeListener

public void removeListener(MdiCloseListener l)

Specified by:

removeListener in interface MdiEntry

Parameters:

l -

triggerCloseListeners

public void triggerCloseListeners(boolean userInitiated)

addListener

public void addListener(MdiChildCloseListener l)

Specified by:

addListener in interface MdiEntry

removeListener

public void removeListener(MdiChildCloseListener l)

Specified by:

removeListener in interface MdiEntry

triggerChildCloseListeners

public void triggerChildCloseListeners(MdiEntry child,
 boolean user)

addListener

public void addListener(MdiEntryOpenListener l)

Specified by:

addListener in interface MdiEntry

Parameters:

l -

removeListener

public void removeListener(MdiEntryOpenListener l)

Specified by:

removeListener in interface MdiEntry

Parameters:

l -

triggerOpenListeners

public void triggerOpenListeners()

addListener

public void addListener(MdiEntryDatasourceListener l)

Specified by:

addListener in interface MdiEntry

removeListener

public void removeListener(MdiEntryDatasourceListener l)

Specified by:

removeListener in interface MdiEntry

triggerDatasourceListeners

public void triggerDatasourceListeners()

addListener

public void addListener(MdiEntryDropListener l)

Specified by:

addListener in interface MdiEntry

removeListener

public void removeListener(MdiEntryDropListener l)

Specified by:

removeListener in interface MdiEntry

hasDropListeners

public boolean hasDropListeners()

triggerDropListeners

public boolean triggerDropListeners(Object o)

Parameters:

o -

Returns:

true: handled; false: not handled

getViewTitleInfo

public ViewTitleInfo getViewTitleInfo()

Specified by:

getViewTitleInfo in interface MdiEntry

Specified by:

getViewTitleInfo in interface UISWTViewCore

Overrides:

getViewTitleInfo in class UISWTViewImpl

setViewTitleInfo

public void setViewTitleInfo(ViewTitleInfo _viewTitleInfo)

Specified by:

setViewTitleInfo in interface MdiEntry

Specified by:

setViewTitleInfo in interface UISWTViewCore

Overrides:

setViewTitleInfo in class UISWTViewImpl

setPluginSkinObject

public void setPluginSkinObject(PluginUISWTSkinObject skinObject)

Specified by:

setPluginSkinObject in interface UISWTViewCore

Overrides:

setPluginSkinObject in class UISWTViewImpl

setSkinObjectMaster

public void setSkinObjectMaster(SWTSkinObject soMaster)

getSkinObject

public SWTSkinObject getSkinObject()

getSkinObjectMaster

public SWTSkinObject getSkinObjectMaster()

setSkinRef

public void setSkinRef(String configID,
 Object params)

getSkinRef

public String getSkinRef()

getTitle

public String getTitle()

Specified by:

getTitle in interface MdiEntry

updateLanguage

public void updateLanguage()

triggerEvent

public void triggerEvent(int eventType,
 Object data)

Description copied from interface: UISWTView

Trigger an event for this view

Specified by:

triggerEvent in interface UISWTView

Overrides:

triggerEvent in class UISWTViewImpl

Parameters:

eventType - Event to trigger UISWTViewEvent}

data - data to send with trigger

show

public void show()

hide

public void hide()

Specified by:

hide in interface MdiEntry

requestAttention

public void requestAttention()

Specified by:

requestAttention in interface MdiEntry

swt_hide

protected void swt_hide()

updateUI

public void updateUI(boolean force)

Specified by:

updateUI in interface MdiEntry

getAutoOpenInfo

public Map<String,Object> getAutoOpenInfo()

Specified by:

getAutoOpenInfo in interface MdiEntry

setCloseable

public void setCloseable(boolean closeable)

setDefaultExpanded

public void setDefaultExpanded(boolean defaultExpanded)

Specified by:

setDefaultExpanded in interface MdiEntry

isExpanded

public boolean isExpanded()

Specified by:

isExpanded in interface MdiEntry

setExpanded

public void setExpanded(boolean expanded)

Specified by:

setExpanded in interface MdiEntry

setMasterComposite

protected void setMasterComposite(org.eclipse.swt.widgets.Composite masterComposite)

Overrides:

setMasterComposite in class UISWTViewImpl

setImageLeftID

public void setImageLeftID(String id)

Specified by:

setImageLeftID in interface MdiEntry

getImageLeftID

public String getImageLeftID()

Specified by:

getImageLeftID in interface MdiEntry

setImageLeft

public void setImageLeft(org.eclipse.swt.graphics.Image imageLeft)

Specified by:

setImageLeft in interface MdiEntrySWT

Parameters:

imageLeft - the imageLeft to set

getImageLeft

public org.eclipse.swt.graphics.Image getImageLeft(String suffix)

Don't forget to releaseImageLeft(String)

releaseImageLeft

public void releaseImageLeft(String suffix)

viewTitleInfoRefresh

protected void viewTitleInfoRefresh(ViewTitleInfo titleInfoToRefresh)

build

public abstract void build()

setPreferredAfterID

public void setPreferredAfterID(String preferredAfterID)

Specified by:

setPreferredAfterID in interface MdiEntry

getPreferredAfterID

public String getPreferredAfterID()

Specified by:

getPreferredAfterID in interface MdiEntry

generate

public void generate(IndentWriter writer)

Specified by:

generate in interface AEDiagnosticsEvidenceGenerator

setEventListener

public void setEventListener(UISWTViewEventListener newEventListener,
 UISWTViewBuilderCore builder,
 boolean doCreate)
                      throws UISWTViewEventCancelledException

Overrides:

setEventListener in class UISWTViewImpl

Throws:

UISWTViewEventCancelledException

setDatasource

public void setDatasource(Object datasource)

Specified by:

setDatasource in interface MdiEntry

Overrides:

setDatasource in class UISWTViewImpl

setTitle

public void setTitle(String title)

Description copied from interface: UISWTView

Override the default title with a new one. After setting this, you should use the UISWTViewEvent.TYPE_LANGUAGEUPDATE to update your title to the new language.

Specified by:

setTitle in interface MdiEntry

Specified by:

setTitle in interface UISWTView

Overrides:

setTitle in class UISWTViewImpl

Parameters:

title - new Title

setTitleID

public void setTitleID(String id)

Specified by:

setTitleID in interface MdiEntry

Overrides:

setTitleID in class UISWTViewImpl

addListener

public void addListener(MdiSWTMenuHackListener l)

Specified by:

addListener in interface MdiEntrySWT

removeListener

public void removeListener(MdiSWTMenuHackListener l)

Specified by:

removeListener in interface MdiEntrySWT

getMenuHackListeners

public MdiSWTMenuHackListener[] getMenuHackListeners()

addAcceleratorListener

public void addAcceleratorListener(MdiAcceleratorListener l)

Specified by:

addAcceleratorListener in interface MdiEntry

removeAcceleratorListener

public void removeAcceleratorListener(MdiAcceleratorListener l)

Specified by:

removeAcceleratorListener in interface MdiEntry

processAccelerator

public boolean processAccelerator(char c,
 int mask)

Specified by:

processAccelerator in interface MdiEntry

canBuildStandAlone

public boolean canBuildStandAlone()

Specified by:

canBuildStandAlone in interface UISWTViewCore

Overrides:

canBuildStandAlone in class UISWTViewImpl

exportStandAlone

public Map<String,Object> exportStandAlone()

buildStandAlone

public SWTSkinObjectContainer buildStandAlone(SWTSkinObjectContainer soParent)

Specified by:

buildStandAlone in interface UISWTViewCore

Overrides:

buildStandAlone in class UISWTViewImpl

importStandAlone

public static SWTSkinObjectContainer importStandAlone(SWTSkinObjectContainer soParent,
 Map<String,Object> map,
 Runnable callback)

tryInstallPlugin

private static void tryInstallPlugin(String plugin_id,
 String plugin_name,
 Runnable callback)

buildStandAlone

public static SWTSkinObjectContainer buildStandAlone(SWTSkinObjectContainer soParent,
 String skinRef,
 SWTSkin skin,
 String id,
 Object datasource,
 int controlType,
 UISWTViewBuilderCore originalBuilder)

Either skinRef or original_builder must be non-null