public interface ToolViewDescriptor extends PageComponentDescriptor
Modifier and Type | Interface and Description |
---|---|
static class |
ToolViewDescriptor.DockSide
Represents all possible tool window docking sides.
|
static class |
ToolViewDescriptor.State
Represents all possible tool window states.
|
Modifier and Type | Field and Description |
---|---|
static String |
PROPERTY_KEY_ACCELERATOR |
static String |
PROPERTY_KEY_INIT_INDEX |
static String |
PROPERTY_KEY_INIT_SIDE |
static String |
PROPERTY_KEY_INIT_STATE |
static String |
PROPERTY_KEY_MNEMONIC |
static String |
PROPERTY_KEY_TOOL_BAR_ID |
PROPERTY_KEY_DESCRIPTION, PROPERTY_KEY_HELP_ID, PROPERTY_KEY_LARGE_ICON, PROPERTY_KEY_MAXIMIZABLE, PROPERTY_KEY_SMALL_ICON, PROPERTY_KEY_TAB_TITLE, PROPERTY_KEY_TITLE
Modifier and Type | Method and Description |
---|---|
Command |
createShowViewCommand(ApplicationPage applicationPage)
Create a command that when executed, will attempt to show the
page component described by this descriptor in the provided
application window.
|
KeyStroke |
getAccelerator() |
int |
getDockedHeight() |
int |
getDockedWidth() |
Rectangle |
getFloatingBounds() |
int |
getInitIndex() |
ToolViewDescriptor.DockSide |
getInitSide() |
ToolViewDescriptor.State |
getInitState() |
char |
getMnemonic() |
String |
getToolBarId()
Gets the ID of the tool bar in which the associated "show view" command will be placed.
|
boolean |
isAutohidable() |
boolean |
isDockable() |
boolean |
isFloatable() |
boolean |
isHidable() |
void |
setAccelerator(KeyStroke accelerator) |
void |
setAutohidable(boolean state) |
void |
setDockable(boolean state) |
void |
setDockedHeight(int dockedHeight) |
void |
setDockedWidth(int dockedWidth) |
void |
setFloatable(boolean state) |
void |
setFloatingBounds(Rectangle floatingBounds) |
void |
setHidable(boolean state) |
void |
setInitIndex(int initIndex) |
void |
setInitSide(ToolViewDescriptor.DockSide initSide) |
void |
setInitState(ToolViewDescriptor.State initState) |
void |
setMnemonic(char mnemonic) |
void |
setToolBarId(String id) |
createPageComponent, getDescription, getHelpId, getId, getLargeIcon, getPreferredSize, getSmallIcon, getTabTitle, getTitle, isEnabled, isMaximizable, isVisible, setDescription, setEnabled, setHelpId, setLargeIcon, setMaximizable, setPreferredSize, setSmallIcon, setTabTitle, setTitle, setVisible
static final String PROPERTY_KEY_MNEMONIC
static final String PROPERTY_KEY_ACCELERATOR
static final String PROPERTY_KEY_INIT_STATE
static final String PROPERTY_KEY_INIT_SIDE
static final String PROPERTY_KEY_INIT_INDEX
static final String PROPERTY_KEY_TOOL_BAR_ID
char getMnemonic()
void setMnemonic(char mnemonic)
mnemonic
- The mnemonic.KeyStroke getAccelerator()
void setAccelerator(KeyStroke accelerator)
accelerator
- The accelerator.ToolViewDescriptor.State getInitState()
void setInitState(ToolViewDescriptor.State initState)
initState
- The initial state.ToolViewDescriptor.DockSide getInitSide()
void setInitSide(ToolViewDescriptor.DockSide initSide)
initSide
- The initial side.int getInitIndex()
void setInitIndex(int initIndex)
initIndex
- The initial index.int getDockedWidth()
void setDockedWidth(int dockedWidth)
dockedWidth
- The docked width in pixels.int getDockedHeight()
void setDockedHeight(int dockedHeight)
dockedHeight
- The docked height in pixels.Rectangle getFloatingBounds()
void setFloatingBounds(Rectangle floatingBounds)
floatingBounds
- The bounds of the tool window when in floating mode.boolean isHidable()
true
if the window is hidable, false
otherwise.void setHidable(boolean state)
state
- true
if the window is hidable, false
otherwise.boolean isDockable()
true
if the window is dockable, false
otherwise.void setDockable(boolean state)
state
- true
if the window is dockable, false
otherwise.boolean isFloatable()
true
if the window is floatable, false
otherwise.void setFloatable(boolean state)
state
- true
if the window is floatable, false
otherwise.boolean isAutohidable()
true
if the window is auto-hidable, false
otherwise.void setAutohidable(boolean state)
state
- true
if the window is auto-hidable, false
otherwise.String getToolBarId()
null
, the associated "show view" command will be placed in the
default tool bar (ID="viewsToolBar").createShowViewCommand(ApplicationPage)
void setToolBarId(String id)
id
- The ID of the tool bar.getToolBarId()
Command createShowViewCommand(ApplicationPage applicationPage)
applicationPage
- The application page.getToolBarId()
Copyright © 2002–2014 Brockmann Consult GmbH. All rights reserved.