public abstract class DockableView extends ViewDecorator implements Dockable
Dockable
interface
docking system and the View
interface.
Addin writers should extend DockableWindow
, and not implement
this interface directly.Modifier and Type | Field and Description |
---|---|
static int |
CLOSED
stateChange constant.
|
static int |
HIDDEN
stateChange constant.
|
static int |
SHOWN
stateChange constant.
|
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 |
DockableView() |
protected |
DockableView(View decorated) |
Modifier and Type | Method and Description |
---|---|
void |
afterAutoExpanding()
Called after this dockable is displayed "auto-expanded."
|
void |
afterRestoringFromAutoExpansion(int orientation,
java.awt.Dimension autoExpandedWindowSize,
boolean userResized)
Called after this dockable is restored from being displayed "auto-expanded."
|
void |
beforeAutoExpanding()
Called before this dockable is going to be displayed "auto-expanded."
|
java.awt.Dimension |
getAutoExpansionPreferredSize(int orientation) |
java.awt.Dimension |
getAutoExpansionSize(int orientation,
javax.swing.JPanel dockedTitledPanel) |
boolean |
isAutoExpandable() |
boolean |
isAutoExpandableEnabled() |
void |
setAutoExpandable(boolean autoExpandable)
Enables/disables "auto-expansion" in this dockable.
|
void |
setAutoExpandableEnabled(boolean autoExpandableEnabled)
Enables or disables the "auto-expand" feature in this dockable.
|
abstract void |
setDockableVisible(boolean bVisible)
Shows/hides the dockable.
|
abstract void |
setType(int type)
Set the dockable type.
|
activate, close, deactivate, getContext, getContextMenu, getController, getDecorated, getGUI, getHelpInfo, getSelectionFromUI, getToolbar, getViewWithoutDecoration, isDecorated, isVisible, loadLayout, newId, saveLayout, setDecorated, setOwner, setToolbarVisible, show, updateTitle, 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
addTitleChangeListener, getDefaultVisibility, getHostedComponent, getMenuTitle, getSite, getTabDropListener, getTabIcon, getTabName, getTitleName, getType, getUniqueName, loadLayout, removeTitleChangeListener, saveLayout, setSite
public static final int SHOWN
Used when the UI is made visible or accessible.
Accessible means it is tabbed with other dockable windows. In this case, the SHOWN stateChange will be sent
although the JComponent.isVisible() == false
.
SHOWN will be used when a layout is loaded as well as when the API is used.
public static final int HIDDEN
HIDDEN is the counterpart of SHOWN
It will be called when the user pressed the 'X' button, and when the layout changes (even if the dockable is
visible in both layouts)
public static final int CLOSED
CLOSED is sent to Dockable that return TYPE_DISCARDABLE on getType().
CLOSED is sent when the close button is pressed after HIDDEN only if the dockable is alone in a window or tabbed
only with other discardable windows.
protected DockableView()
protected DockableView(View decorated)
public abstract void setDockableVisible(boolean bVisible)
public abstract void setType(int type)
public final boolean isAutoExpandable()
isAutoExpandable
in interface Dockable
true
if this dockable can be auto-expanded.
Auto-expansion is the ability to be automatically expanded when the user hovers over a hot spot (usually the
dockable's tab or the whole dockable if it is fully visible). This effect is similar to the expansion shown when
a dockable is minimized and a user hover over the minimized dockable.public final void setAutoExpandable(boolean autoExpandable)
setAutoExpandable
in interface Dockable
autoExpandable
- the new value for "auto-expansion".Dockable.isAutoExpandable()
public final boolean isAutoExpandableEnabled()
isAutoExpandableEnabled
in interface Dockable
true
if this dockable is "auto-expandable" and if the "auto-expand" feature is enabled.Dockable.isAutoExpandable()
public final void setAutoExpandableEnabled(boolean autoExpandableEnabled)
Dockable.isAutoExpandable()
is true
setAutoExpandableEnabled
in interface Dockable
autoExpandableEnabled
- the new value to enable/disable the "auto-expand" feature in this dockable.public void beforeAutoExpanding()
beforeAutoExpanding
in interface Dockable
public void afterAutoExpanding()
afterAutoExpanding
in interface Dockable
public void afterRestoringFromAutoExpansion(int orientation, java.awt.Dimension autoExpandedWindowSize, boolean userResized)
afterRestoringFromAutoExpansion
in interface Dockable
orientation
- the orientation of this dockableIdeConstants.WEST
,
IdeConstants.EAST
,
IdeConstants.NORTH
,
IdeConstants.SOUTH
public java.awt.Dimension getAutoExpansionSize(int orientation, javax.swing.JPanel dockedTitledPanel)
getAutoExpansionSize
in interface Dockable
orientation
- the orientation of this dockabledockedTitledPanel
- the titled panel holding the dockable to be shown "auto-expanded"IdeConstants.WEST
,
IdeConstants.EAST
,
IdeConstants.NORTH
,
IdeConstants.SOUTH
public java.awt.Dimension getAutoExpansionPreferredSize(int orientation)
getAutoExpansionPreferredSize
in interface Dockable
orientation
- the orientation of this dockableIdeConstants.WEST
,
IdeConstants.EAST
,
IdeConstants.NORTH
,
IdeConstants.SOUTH