public interface Mode extends Serializable
TopComponent
has to be added to
in order to be managed by window system.
There is always present default document mode named "editor". Modules can add their own modes by declaring them using XML.
Modules can get a set of current modes by calling
WindowManager.getModes()
.
Each mode must have a unique name.
Important note: Do not provide implementation of this interface unless you are window system provider!
Modifier and Type | Interface and Description |
---|---|
static interface |
Mode.Xml
Extension to provide exposure of XML configuration.
|
Modifier and Type | Field and Description |
---|---|
static String |
PROP_BOUNDS
Name of property for bounds of the mode
|
static String |
PROP_DISPLAY_NAME
Deprecated.
Do not use. It is redundant.
|
static String |
PROP_NAME
Deprecated.
Do not use. It is redundant, name can not be changed.
|
static long |
serialVersionUID
Deprecated.
Only public by accident.
|
Modifier and Type | Method and Description |
---|---|
void |
addPropertyChangeListener(PropertyChangeListener list)
Add a property change listener.
|
boolean |
canDock(TopComponent tc)
Allows implementor to specify some restrictive policy as to which
top components can be docked into this mode.
|
boolean |
dockInto(TopComponent c)
Attaches a component to a mode for this workspace.
|
Rectangle |
getBounds()
Getter for current bounds of the mode.
|
String |
getDisplayName()
Deprecated.
Do not use. It is redudant.
|
Image |
getIcon()
Deprecated.
Do not use. It is redundant.
|
String |
getName()
Get the programmatic name of the mode.
|
TopComponent |
getSelectedTopComponent()
Gets selected
TopComponent in this mode. |
TopComponent[] |
getTopComponents()
Get all top components currently docked into this mode.
|
Workspace |
getWorkspace()
Deprecated.
Do not use. Worskpaces are not supporeted anymore.
|
void |
removePropertyChangeListener(PropertyChangeListener list)
Remove a property change listener.
|
void |
setBounds(Rectangle s)
Sets the bounds of the mode.
|
static final String PROP_BOUNDS
static final String PROP_NAME
static final String PROP_DISPLAY_NAME
static final long serialVersionUID
String getDisplayName()
String getName()
Image getIcon()
null
if no icon was specified)boolean dockInto(TopComponent c)
c
- componentboolean canDock(TopComponent tc)
void setBounds(Rectangle s)
s
- the bounds for the modeRectangle getBounds()
Workspace getWorkspace()
TopComponent[] getTopComponents()
void addPropertyChangeListener(PropertyChangeListener list)
list
- the listener to addvoid removePropertyChangeListener(PropertyChangeListener list)
list
- the listener to removeTopComponent getSelectedTopComponent()
TopComponent
in this mode.