Package com.biglybt.ui.mdi
Interface MdiEntry
-
- All Superinterfaces:
UIPluginView
- All Known Subinterfaces:
MdiEntrySWT
- All Known Implementing Classes:
BaseMdiEntry
,SideBarEntrySWT
,TabbedEntry
public interface MdiEntry extends UIPluginView
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 + BaseMdiEntry
MdiEntry differ from UISWTView in that they contain MDI related properties, such asViewTitleInfo
,MdiEntryVitalityImage
, expand state, parent entry, etc.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description void
addListener(MdiChildCloseListener l)
void
addListener(MdiCloseListener l)
void
addListener(MdiEntryDatasourceListener l)
void
addListener(MdiEntryDropListener listener)
void
addListener(MdiEntryOpenListener l)
void
addListeners(java.lang.Object objectWithListeners)
void
addToolbarEnabler(UIToolBarEnablerBase enabler)
MdiEntryVitalityImage
addVitalityImage(java.lang.String imageID)
boolean
close(boolean forceClose)
Deprecated.usecloseView()
void
closeView()
Closes this entry.java.util.Map<java.lang.String,java.lang.Object>
getAutoOpenInfo()
java.lang.Object
getDatasource()
Deprecated.java.lang.Object
getExportableDatasource()
Return an exportable version of the datasource.java.lang.String
getId()
Deprecated.java.lang.String
getImageLeftID()
MultipleDocumentInterface
getMDI()
java.lang.String
getParentID()
ID of Parent MdiEntryjava.lang.String
getPreferredAfterID()
java.lang.String
getTitle()
UIToolBarEnablerBase[]
getToolbarEnablers()
java.lang.Object
getUserData(java.lang.Object key)
ViewTitleInfo
getViewTitleInfo()
java.util.List<? extends MdiEntryVitalityImage>
getVitalityImages()
void
hide()
boolean
isCloseable()
boolean
isContentDisposed()
Whether the content of this entry is disposed.boolean
isEntryDisposed()
Whether this entry is disposed.boolean
isExpanded()
boolean
isSelectable()
void
redraw()
void
removeListener(MdiChildCloseListener l)
void
removeListener(MdiCloseListener l)
void
removeListener(MdiEntryDatasourceListener l)
void
removeListener(MdiEntryDropListener listener)
void
removeListener(MdiEntryOpenListener l)
void
removeToolbarEnabler(UIToolBarEnablerBase enabler)
void
requestAttention()
void
setDatasource(java.lang.Object ds)
void
setDefaultExpanded(boolean defaultExpanded)
void
setExpanded(boolean expanded)
void
setImageLeftID(java.lang.String string)
void
setParentEntryID(java.lang.String parentEntryID)
Set this entries belonging under another MdiEntryvoid
setPreferredAfterID(java.lang.String preferredAfterID)
void
setSelectable(boolean selectable)
void
setTitle(java.lang.String title)
void
setTitleID(java.lang.String titleID)
void
setUserData(java.lang.Object key, java.lang.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 Detail
-
getParentID
java.lang.String getParentID()
ID of Parent MdiEntry
-
getDatasource
java.lang.Object getDatasource()
Deprecated.
-
getExportableDatasource
java.lang.Object getExportableDatasource()
Return an exportable version of the datasource. Usually String, but can be Map and List
-
isCloseable
boolean isCloseable()
-
getId
java.lang.String getId()
Deprecated.
-
addVitalityImage
MdiEntryVitalityImage addVitalityImage(java.lang.String imageID)
-
addListeners
void addListeners(java.lang.Object objectWithListeners)
-
addListener
void addListener(MdiCloseListener l)
- Parameters:
l
-- Since:
- 4.1.0.3
-
addListener
void addListener(MdiChildCloseListener l)
-
removeListener
void removeListener(MdiCloseListener l)
- Parameters:
l
-- Since:
- 4.1.0.3
-
removeListener
void removeListener(MdiChildCloseListener l)
-
addListener
void addListener(MdiEntryOpenListener l)
- Parameters:
l
-- Since:
- 4.1.0.3
-
removeListener
void removeListener(MdiEntryOpenListener l)
- Parameters:
l
-- Since:
- 4.1.0.3
-
addListener
void addListener(MdiEntryDatasourceListener l)
-
removeListener
void removeListener(MdiEntryDatasourceListener l)
-
setImageLeftID
void setImageLeftID(java.lang.String string)
-
addListener
void addListener(MdiEntryDropListener listener)
-
removeListener
void removeListener(MdiEntryDropListener listener)
-
setDatasource
void setDatasource(java.lang.Object ds)
-
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
void setViewTitleInfo(ViewTitleInfo viewTitleInfo)
-
getMDI
MultipleDocumentInterface getMDI()
-
getVitalityImages
java.util.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
java.lang.String getTitle()
-
setTitle
void setTitle(java.lang.String title)
-
setTitleID
void setTitleID(java.lang.String titleID)
-
getImageLeftID
java.lang.String getImageLeftID()
-
isExpanded
boolean isExpanded()
-
setExpanded
void setExpanded(boolean expanded)
-
setDefaultExpanded
void setDefaultExpanded(boolean defaultExpanded)
-
setParentEntryID
void setParentEntryID(java.lang.String parentEntryID)
Set this entries belonging under another MdiEntry- Parameters:
parentEntryID
- Parent Entry ID to place under (if MDI supports it)
-
getToolbarEnablers
UIToolBarEnablerBase[] getToolbarEnablers()
-
addToolbarEnabler
void addToolbarEnabler(UIToolBarEnablerBase enabler)
-
removeToolbarEnabler
void removeToolbarEnabler(UIToolBarEnablerBase enabler)
-
isSelectable
boolean isSelectable()
-
setSelectable
void setSelectable(boolean selectable)
-
setPreferredAfterID
void setPreferredAfterID(java.lang.String preferredAfterID)
-
getPreferredAfterID
java.lang.String getPreferredAfterID()
-
setUserData
void setUserData(java.lang.Object key, java.lang.Object value)
-
getUserData
java.lang.Object getUserData(java.lang.Object key)
-
getAutoOpenInfo
java.util.Map<java.lang.String,java.lang.Object> getAutoOpenInfo()
-
-