Package com.biglybt.ui.mdi
Interface MdiEntry
- All Superinterfaces:
UIPluginView
- All Known Subinterfaces:
MdiEntrySWT
- All Known Implementing Classes:
BaseMdiEntry
,SideBarEntrySWT
,TabbedEntry
A view (entry) that can be placed in a MDI (Multiple Document Interface).
Successor to UISWTView, this class is not SWT specific. In fact, UISWTView
and MdiEntry merge into a implementation class MdiEntrySWT later on:
UIPluginView + UISWTView | + UISWTViewCore | + MdiEntrySWT | | + BaseMdiEntry | + UISWTViewImpl | + BaseMdiEntry + MdiEntry + MdiEntrySWT + BaseMdiEntryMdiEntry differ from UISWTView in that they contain MDI related properties, such as
ViewTitleInfo
, MdiEntryVitalityImage
, expand state,
parent entry, etc.-
Method Summary
Modifier and TypeMethodDescriptionvoid
addAcceleratorListener
(MdiAcceleratorListener listener) void
void
void
void
addListener
(MdiEntryDropListener listener) void
void
addListeners
(Object objectWithListeners) void
addToolbarEnabler
(UIToolBarEnablerBase enabler) addVitalityImage
(String imageID) boolean
close
(boolean forceClose) Deprecated.void
Closes this entry.Deprecated.Return an exportable version of the datasource.getId()
Deprecated.getMDI()
ID of Parent MdiEntrygetTitle()
getUserData
(Object key) List<? extends MdiEntryVitalityImage>
void
hide()
boolean
boolean
Whether the content of this entry is disposed.boolean
Whether this entry is disposed.boolean
boolean
boolean
processAccelerator
(char c, int stateMask) void
redraw()
void
void
void
void
void
removeListener
(MdiEntryDropListener listener) void
void
removeToolbarEnabler
(UIToolBarEnablerBase enabler) void
void
setDatasource
(Object ds) void
setDefaultExpanded
(boolean defaultExpanded) void
setExpanded
(boolean expanded) void
setImageLeftID
(String string) void
setParentEntryID
(String parentEntryID) Set this entries belonging under another MdiEntryvoid
setPreferredAfterID
(String preferredAfterID) void
setSelectable
(boolean selectable) void
void
setTitleID
(String titleID) void
setUserData
(Object key, Object value) void
setViewTitleInfo
(ViewTitleInfo viewTitleInfo) void
updateUI
(boolean force) Methods inherited from interface com.biglybt.pif.ui.UIPluginView
getDataSource, getPluginInterface, getToolBarListener, getViewID, setToolBarListener
-
Method Details
-
getParentID
String getParentID()ID of Parent MdiEntry -
getDatasource
Object getDatasource()Deprecated. -
getExportableDatasource
Object getExportableDatasource()Return an exportable version of the datasource. Usually String, but can be Map and List -
isCloseable
boolean isCloseable() -
getId
String getId()Deprecated. -
addVitalityImage
-
addListeners
-
addListener
- Parameters:
l
-- Since:
- 4.1.0.3
-
addListener
-
removeListener
- Parameters:
l
-- Since:
- 4.1.0.3
-
removeListener
-
addListener
- Parameters:
l
-- Since:
- 4.1.0.3
-
removeListener
- Parameters:
l
-- Since:
- 4.1.0.3
-
addListener
-
removeListener
-
setImageLeftID
-
addListener
-
removeListener
-
addAcceleratorListener
-
processAccelerator
boolean processAccelerator(char c, int stateMask) -
removeAcceleratorListener
-
setDatasource
-
isContentDisposed
boolean isContentDisposed()Whether the content of this entry is disposed. Content can be disposed while entry is not disposed. Content is always disposed when entry is disposed. -
isEntryDisposed
boolean isEntryDisposed()Whether this entry is disposed. Content can be disposed while entry is not disposed. Content is always disposed when entry is disposed. -
getViewTitleInfo
ViewTitleInfo getViewTitleInfo() -
setViewTitleInfo
-
getMDI
MultipleDocumentInterface getMDI() -
getVitalityImages
List<? extends MdiEntryVitalityImage> getVitalityImages() -
close
boolean close(boolean forceClose) Deprecated.usecloseView()
Closes this entry. Disposes this entry and its contents.- 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
void closeView()Closes this entry. Disposes this entry and its contents. Removes entry from auto-open list.- Specified by:
closeView
in interfaceUIPluginView
-
updateUI
void updateUI(boolean force) -
redraw
void redraw() -
hide
void hide() -
requestAttention
void requestAttention() -
getTitle
String getTitle() -
setTitle
-
setTitleID
-
getImageLeftID
String getImageLeftID() -
isExpanded
boolean isExpanded() -
setExpanded
void setExpanded(boolean expanded) -
setDefaultExpanded
void setDefaultExpanded(boolean defaultExpanded) -
setParentEntryID
Set this entries belonging under another MdiEntry- Parameters:
parentEntryID
- Parent Entry ID to place under (if MDI supports it)
-
getToolbarEnablers
UIToolBarEnablerBase[] getToolbarEnablers() -
addToolbarEnabler
-
removeToolbarEnabler
-
isSelectable
boolean isSelectable() -
setSelectable
void setSelectable(boolean selectable) -
setPreferredAfterID
-
getPreferredAfterID
String getPreferredAfterID() -
setUserData
-
getUserData
-
getAutoOpenInfo
-
closeView()