Package com.biglybt.ui.swt.mdi
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
,ViewTitleInfoListener
,MdiEntry
,ObfuscateImage
,MdiEntrySWT
,UISWTView
,UISWTViewCore
- Direct Known Subclasses:
SideBarEntrySWT
,TabbedEntry
public abstract class BaseMdiEntry
extends UISWTViewImpl
implements MdiEntrySWT, ViewTitleInfoListener, AEDiagnosticsEvidenceGenerator, ObfuscateImage
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate boolean
private boolean
private boolean
private org.eclipse.swt.graphics.Image
private String
private Boolean
private long
private List
<MdiAcceleratorListener> private List
<MdiChildCloseListener> private List
<MdiCloseListener> private List
<MdiEntryDatasourceListener> private List
<MdiEntryDropListener> private List
<MdiSWTMenuHackListener> private List
<MdiEntryOpenListener> private List
<MdiEntryVitalityImageSWT> protected final BaseMDI
private String
Parent MDIEntry.private String
private String
protected static final String
private SWTSkinObject
protected static long
protected ViewTitleInfo
Fields inherited from class com.biglybt.ui.swt.pifimpl.UISWTViewImpl
CFG_PREFIX, composite, datasource, id, skin, skinObject
Fields inherited from interface com.biglybt.ui.swt.pif.UISWTView
CONTROLTYPE_AWT, CONTROLTYPE_SWT
Fields inherited from interface com.biglybt.ui.swt.pifimpl.UISWTViewCore
CONTROLTYPE_SKINOBJECT, UD_STANDALONE_DATA_SOURCE
Fields inherited from interface com.biglybt.pif.ui.toolbar.UIToolBarActivationListener
ACTIVATIONTYPE_HELD, ACTIVATIONTYPE_NORMAL, ACTIVATIONTYPE_RIGHTCLICK
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
void
void
void
void
void
void
void
addListeners
(Object objectWithListeners) addVitalityImage
(String imageID) abstract void
build()
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-nullboolean
boolean
close
(boolean forceClose) Closes this entry.void
Closes the viewvoid
closeView
(boolean userInitiated) protected void
destroyEntry
(boolean userInitiated) protected void
void
generate
(IndentWriter writer) Return an exportable version of the datasource.getId()
org.eclipse.swt.graphics.Image
getImageLeft
(String suffix) Don't forget toreleaseImageLeft(String)
getMDI()
ID of Parent MdiEntrygetTitle()
boolean
void
hide()
static SWTSkinObjectContainer
importStandAlone
(SWTSkinObjectContainer soParent, Map<String, Object> map, Runnable callback) boolean
boolean
boolean
processAccelerator
(char c, int mask) void
releaseImageLeft
(String suffix) void
void
void
void
void
void
void
void
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 MdiEntryvoid
setPluginSkinObject
(PluginUISWTSkinObject skinObject) void
setPreferredAfterID
(String preferredAfterID) void
setSkinObjectMaster
(SWTSkinObject soMaster) void
setSkinRef
(String configID, Object params) void
Override the default title with a new one.void
setTitleID
(String id) void
setViewTitleInfo
(ViewTitleInfo viewTitleInfo) void
show()
protected void
swt_hide()
void
triggerChildCloseListeners
(MdiEntry child, boolean user) void
triggerCloseListeners
(boolean userInitiated) void
boolean
void
triggerEvent
(int eventType, Object data) Trigger an event for this viewvoid
private static void
tryInstallPlugin
(String plugin_id, String plugin_name, Runnable callback) void
void
updateUI
(boolean force) void
viewTitleInfoRefresh
(ViewTitleInfo titleInfoToRefresh) Methods inherited from class com.biglybt.ui.swt.pifimpl.UISWTViewImpl
addToolbarEnabler, buildStandAlone, create, getComposite, getControlType, getDataSource, getEventListener, getEventListenerBuilder, getFullTitle, getInitialDataSource, getParentView, getPluginInterface, getPluginSkinObject, getTitleID, getToolbarEnablers, getToolBarListener, getUserData, getViewID, 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 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.biglybt.ui.mdi.MdiEntry
addToolbarEnabler, getToolbarEnablers, getUserData, isContentDisposed, isEntryDisposed, isSelectable, redraw, removeToolbarEnabler, setSelectable, setUserData
Methods inherited from interface com.biglybt.ui.swt.mdi.MdiEntrySWT
redraw
Methods inherited from interface com.biglybt.ui.swt.debug.ObfuscateImage
obfuscatedImage
Methods inherited from interface com.biglybt.pif.ui.UIPluginView
getToolBarListener, getViewID, setToolBarListener
Methods inherited from interface com.biglybt.pif.ui.UIPluginViewToolBarListener
isActive
Methods inherited from interface com.biglybt.ui.swt.pif.UISWTView
getControlType, getInitialDataSource, getParentView, getPluginInterface, isContentDisposed, isDestroyOnDeactivate, setControlType, setDestroyOnDeactivate
Methods inherited from interface com.biglybt.ui.swt.pifimpl.UISWTViewCore
getComposite, getDataSource, getEventListener, getEventListenerBuilder, getFullTitle, getPluginSkinObject, getTitleID, getUserData, initialize, setParentView, setUseCoreDataSource, setUserData, useCoreDataSource
-
Field Details
-
SO_ID_ENTRY_WRAPPER
- See Also:
-
uniqueNumber
protected static long uniqueNumber -
mdi
-
skinRef
-
listCloseListeners
-
listChildCloseListeners
-
listOpenListeners
-
listDropListeners
-
listDatasourceListeners
-
listMenuHackListners
-
listAcceleratorListeners
-
viewTitleInfo
-
parentEntryID
Parent MDIEntry. Doesn't mean that this view is embedded inside the parentID -
closeable
private boolean closeable -
isExpanded
-
imageLeftID
-
imageLeft
private org.eclipse.swt.graphics.Image imageLeft -
collapseDisabled
private boolean collapseDisabled -
soMaster
-
preferredAfterID
-
hasBeenOpened
private boolean hasBeenOpened -
listVitalityImages
-
lastUpdateUI
private long lastUpdateUI -
installing_pids
-
builder_waiters
-
-
Constructor Details
-
BaseMdiEntry
-
-
Method Details
-
getId
-
addVitalityImage
- Specified by:
addVitalityImage
in interfaceMdiEntry
-
getVitalityImages
- Specified by:
getVitalityImages
in interfaceMdiEntry
-
close
public boolean close(boolean forceClose) Description copied from interface:MdiEntry
Closes this entry. Disposes this entry and its contents. -
closeView
public void closeView()Description copied from interface:UIPluginView
Closes the view- Specified by:
closeView
in interfaceMdiEntry
- Specified by:
closeView
in interfaceUIPluginView
- Overrides:
closeView
in classUISWTViewImpl
-
closeView
public void closeView(boolean userInitiated) -
destroyEntry
protected void destroyEntry(boolean userInitiated) -
destroyEntryAlways
protected void destroyEntryAlways() -
getDatasourceCore
-
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 interfaceMdiEntry
-
getDatasource
- Specified by:
getDatasource
in interfaceMdiEntry
-
getMDI
-
getParentID
Description copied from interface:MdiEntry
ID of Parent MdiEntry- Specified by:
getParentID
in interfaceMdiEntry
-
setParentEntryID
Description copied from interface:MdiEntry
Set this entries belonging under another MdiEntry- Specified by:
setParentEntryID
in interfaceMdiEntry
- Parameters:
parentEntryID
- Parent Entry ID to place under (if MDI supports it)
-
isCloseable
public boolean isCloseable()- Specified by:
isCloseable
in interfaceMdiEntry
-
addListeners
- Specified by:
addListeners
in interfaceMdiEntry
-
addListener
- Specified by:
addListener
in interfaceMdiEntry
- Parameters:
l
-
-
removeListener
- Specified by:
removeListener
in interfaceMdiEntry
- Parameters:
l
-
-
triggerCloseListeners
public void triggerCloseListeners(boolean userInitiated) -
addListener
- Specified by:
addListener
in interfaceMdiEntry
-
removeListener
- Specified by:
removeListener
in interfaceMdiEntry
-
triggerChildCloseListeners
-
addListener
- Specified by:
addListener
in interfaceMdiEntry
- Parameters:
l
-
-
removeListener
- Specified by:
removeListener
in interfaceMdiEntry
- Parameters:
l
-
-
triggerOpenListeners
public void triggerOpenListeners() -
addListener
- Specified by:
addListener
in interfaceMdiEntry
-
removeListener
- Specified by:
removeListener
in interfaceMdiEntry
-
triggerDatasourceListeners
public void triggerDatasourceListeners() -
addListener
- Specified by:
addListener
in interfaceMdiEntry
-
removeListener
- Specified by:
removeListener
in interfaceMdiEntry
-
hasDropListeners
public boolean hasDropListeners() -
triggerDropListeners
- Parameters:
o
-- Returns:
- true: handled; false: not handled
-
getViewTitleInfo
- Specified by:
getViewTitleInfo
in interfaceMdiEntry
- Specified by:
getViewTitleInfo
in interfaceUISWTViewCore
- Overrides:
getViewTitleInfo
in classUISWTViewImpl
-
setViewTitleInfo
- Specified by:
setViewTitleInfo
in interfaceMdiEntry
- Specified by:
setViewTitleInfo
in interfaceUISWTViewCore
- Overrides:
setViewTitleInfo
in classUISWTViewImpl
-
setPluginSkinObject
- Specified by:
setPluginSkinObject
in interfaceUISWTViewCore
- Overrides:
setPluginSkinObject
in classUISWTViewImpl
-
setSkinObjectMaster
-
getSkinObject
-
getSkinObjectMaster
-
setSkinRef
-
getSkinRef
-
getTitle
-
updateLanguage
public void updateLanguage() -
triggerEvent
Description copied from interface:UISWTView
Trigger an event for this view- Specified by:
triggerEvent
in interfaceUISWTView
- Overrides:
triggerEvent
in classUISWTViewImpl
- Parameters:
eventType
- Event to triggerUISWTViewEvent
}data
- data to send with trigger
-
show
public void show() -
hide
public void hide() -
requestAttention
public void requestAttention()- Specified by:
requestAttention
in interfaceMdiEntry
-
swt_hide
protected void swt_hide() -
updateUI
public void updateUI(boolean force) -
getAutoOpenInfo
- Specified by:
getAutoOpenInfo
in interfaceMdiEntry
-
setCloseable
public void setCloseable(boolean closeable) -
setDefaultExpanded
public void setDefaultExpanded(boolean defaultExpanded) - Specified by:
setDefaultExpanded
in interfaceMdiEntry
-
isExpanded
public boolean isExpanded()- Specified by:
isExpanded
in interfaceMdiEntry
-
setExpanded
public void setExpanded(boolean expanded) - Specified by:
setExpanded
in interfaceMdiEntry
-
setMasterComposite
protected void setMasterComposite(org.eclipse.swt.widgets.Composite masterComposite) - Overrides:
setMasterComposite
in classUISWTViewImpl
-
setImageLeftID
- Specified by:
setImageLeftID
in interfaceMdiEntry
-
getImageLeftID
- Specified by:
getImageLeftID
in interfaceMdiEntry
-
setImageLeft
public void setImageLeft(org.eclipse.swt.graphics.Image imageLeft) - Specified by:
setImageLeft
in interfaceMdiEntrySWT
- Parameters:
imageLeft
- the imageLeft to set
-
getImageLeft
Don't forget toreleaseImageLeft(String)
-
releaseImageLeft
-
viewTitleInfoRefresh
- Specified by:
viewTitleInfoRefresh
in interfaceViewTitleInfoListener
-
build
public abstract void build() -
setPreferredAfterID
- Specified by:
setPreferredAfterID
in interfaceMdiEntry
-
getPreferredAfterID
- Specified by:
getPreferredAfterID
in interfaceMdiEntry
-
generate
- Specified by:
generate
in interfaceAEDiagnosticsEvidenceGenerator
-
setEventListener
public void setEventListener(UISWTViewEventListener newEventListener, UISWTViewBuilderCore builder, boolean doCreate) throws UISWTViewEventCancelledException - Overrides:
setEventListener
in classUISWTViewImpl
- Throws:
UISWTViewEventCancelledException
-
setDatasource
- Specified by:
setDatasource
in interfaceMdiEntry
- Overrides:
setDatasource
in classUISWTViewImpl
-
setTitle
Description copied from interface:UISWTView
Override the default title with a new one. After setting this, you should use theUISWTViewEvent.TYPE_LANGUAGEUPDATE
to update your title to the new language. -
setTitleID
- Specified by:
setTitleID
in interfaceMdiEntry
- Overrides:
setTitleID
in classUISWTViewImpl
-
addListener
- Specified by:
addListener
in interfaceMdiEntrySWT
-
removeListener
- Specified by:
removeListener
in interfaceMdiEntrySWT
-
getMenuHackListeners
-
addAcceleratorListener
- Specified by:
addAcceleratorListener
in interfaceMdiEntry
-
removeAcceleratorListener
- Specified by:
removeAcceleratorListener
in interfaceMdiEntry
-
processAccelerator
public boolean processAccelerator(char c, int mask) - Specified by:
processAccelerator
in interfaceMdiEntry
-
canBuildStandAlone
public boolean canBuildStandAlone()- Specified by:
canBuildStandAlone
in interfaceUISWTViewCore
- Overrides:
canBuildStandAlone
in classUISWTViewImpl
-
exportStandAlone
-
buildStandAlone
- Specified by:
buildStandAlone
in interfaceUISWTViewCore
- Overrides:
buildStandAlone
in classUISWTViewImpl
-
importStandAlone
public static SWTSkinObjectContainer importStandAlone(SWTSkinObjectContainer soParent, Map<String, Object> map, Runnable callback) -
tryInstallPlugin
-
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
-