public abstract class DockableWindow extends DockableView
Dockable
interface
docking system and the View
interface.
Addin writers should extend this class and not implement Dockable
or DockableView
directly.CLOSED, HIDDEN, SHOWN
EMPTY_SELECTION, PROJECT_PROP, VISIBLE_PROP, WORKSPACE_PROP
DEFAULT_VISIBILITY_MINIMIZED, DEFAULT_VISIBILITY_RAISED, DEFAULT_VISIBILITY_VISIBLE, TYPE_DISCARDABLE, TYPE_FORGETTABLE, TYPE_GLOBAL_VISIBLE, TYPE_NO_BUTTONS, TYPE_NORMAL, TYPE_NOT_TABBED, TYPE_RECYCLABLE, TYPE_TRUNCATE_TITLE
Modifier | Constructor and Description |
---|---|
protected |
DockableWindow() |
protected |
DockableWindow(IdeMainWindow owner,
java.lang.String viewId)
Don't use this constructor.
|
protected |
DockableWindow(java.lang.String viewId)
Constructor.
|
protected |
DockableWindow(View decorated)
Only for decorator pattern.
|
protected |
DockableWindow(View owner,
java.lang.String viewId)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
void |
addTitleChangeListener(TitleChangeListener l)
Adds a title change listener to a dockable.
|
void |
close()
Closes the view.
|
protected void |
dockableHidden(DockableEvent e)
This method is called when the window is hidden or closed.
|
protected void |
dockableShown(DockableEvent e)
This method is called when the window is shown.
|
protected void |
fireTitleChangeListener() |
protected Dockable |
getCachedDockable()
This method returns the Dockable as know by the docking system based on the
view ID.
|
int |
getDefaultVisibility(Layout layout)
The first time a Dockable is exposed to a layout, if the dockable is not of type
Dockable.TYPE_GLOBAL_VISIBLE ,
it will be asked if it wants to be shown in that layout. |
java.util.List<javax.swing.JComponent> |
getHeaderComponents()
a DockableWindow may have pre-defined built-in places to display extra actions.
|
javax.swing.JComponent |
getHostedComponent()
Gets the root component of the user interface to be docked or floated.
|
java.lang.String |
getMenuTitle()
Gets the text to display in the menus of the docking for showing/hiding
the dockable.
|
Site |
getSite()
Gets a storage object for docking information.
|
java.awt.dnd.DropTargetListener |
getTabDropListener()
Gets the drop target listener for drop events on the tab.
|
javax.swing.Icon |
getTabIcon()
Gets the icon to display in a tab along side the name.
|
int |
getType()
Gets the types of dockable accepted by a specific dockable implementation.
|
java.lang.String |
getUniqueName()
Gets a unique name used for persistence.
|
boolean |
isDrawer()
Indcates if Dockable is used as Drawer (accordion).
|
boolean |
isVisible() |
void |
removeTitleChangeListener(TitleChangeListener l)
Removes the specified title change listener from the dockable.
|
void |
setDockableVisible(boolean bVisible)
Shows/hides the dockable.
|
void |
setSite(Site site)
Sets the current site where this dockable is docked or floated.
|
void |
setType(int type)
Set the dockable type.
|
void |
show()
Shows the view if hidden.
|
void |
stateChange(int newState)
This method gets called when a panel is shown, hidden, or closed.
|
void |
updateTitle(java.lang.Object object)
Called when the view needs to update its title based on the
specified object.
|
afterAutoExpanding, afterRestoringFromAutoExpansion, beforeAutoExpanding, getAutoExpansionPreferredSize, getAutoExpansionSize, isAutoExpandable, isAutoExpandableEnabled, setAutoExpandable, setAutoExpandableEnabled
activate, deactivate, getContext, getContextMenu, getController, getDecorated, getGUI, getHelpInfo, getSelectionFromUI, getToolbar, getViewWithoutDecoration, isDecorated, loadLayout, newId, saveLayout, setDecorated, setOwner, setToolbarVisible, updateVisibleActions
addViewListener, addViewSelectionListener, addViewStateListener, fireViewCollapsed, fireViewExpanded, fireViewSelectionChanged, getContext, getId, getSelection, getTabName, loadManifestToolbar, loadManifestToolbar, owner, removeViewListener, removeViewSelectionListener, removeViewStateListener, scheduleUpdateSelection, setId, toString, updateSelection, updateSelectionImpl, updateToolbarActions, updateVisibleActions
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getTabName, getTitleName, loadLayout, saveLayout
protected DockableWindow()
protected DockableWindow(View decorated)
decorated
- protected DockableWindow(java.lang.String viewId)
protected DockableWindow(View owner, java.lang.String viewId)
protected DockableWindow(IdeMainWindow owner, java.lang.String viewId)
protected Dockable getCachedDockable()
public void close()
close
in class ViewDecorator
public void show()
show
in class ViewDecorator
public boolean isVisible()
isVisible
in class ViewDecorator
public void setDockableVisible(boolean bVisible)
setDockableVisible
in class DockableView
public void updateTitle(java.lang.Object object)
updateTitle
in class ViewDecorator
object
- the specified object.public javax.swing.Icon getTabIcon()
View.getTabName()
public int getType()
public void setType(int type)
DockableView
setType
in class DockableView
public java.lang.String getUniqueName()
public Site getSite()
setSite(oracle.ide.docking.Site)
public void setSite(Site site)
site
- the site to set.getSite()
public javax.swing.JComponent getHostedComponent()
public java.awt.dnd.DropTargetListener getTabDropListener()
If handling drop events on the tab is not necessary, the implementation of this method should return null.
Note that this method may called repeatedly during a drag and drop operation, so it should be fast.
public java.lang.String getMenuTitle()
public java.util.List<javax.swing.JComponent> getHeaderComponents()
A dockable may supply a list of components to display in such a place.
public int getDefaultVisibility(Layout layout)
Dockable
Dockable.TYPE_GLOBAL_VISIBLE
,
it will be asked if it wants to be shown in that layout.public void addTitleChangeListener(TitleChangeListener l)
l
- a TitleChangeListener instance.public void removeTitleChangeListener(TitleChangeListener l)
l
- a TitleChangeListener instance.public void stateChange(int newState)
newState
- The new state indicating whether the panel was shown,
hidden or closed.protected void fireTitleChangeListener()
protected void dockableHidden(DockableEvent e)
DockableView.HIDDEN
).protected void dockableShown(DockableEvent e)
DockableView.SHOWN
).public boolean isDrawer()