public class DefaultToolViewDescriptor extends Object implements ToolViewDescriptor, com.bc.ceres.core.runtime.ConfigurableExtension
ToolViewDescriptor
.ToolViewDescriptor.DockSide, ToolViewDescriptor.State
PROPERTY_KEY_ACCELERATOR, PROPERTY_KEY_INIT_INDEX, PROPERTY_KEY_INIT_SIDE, PROPERTY_KEY_INIT_STATE, PROPERTY_KEY_MNEMONIC, 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
Constructor and Description |
---|
DefaultToolViewDescriptor() |
public String getId()
getId
in interface PageComponentDescriptor
public String getHelpId()
getHelpId
in interface PageComponentDescriptor
public void setHelpId(String helpId)
setHelpId
in interface PageComponentDescriptor
helpId
- The help identifier.public String getTitle()
getTitle
in interface PageComponentDescriptor
public void setTitle(String title)
setTitle
in interface PageComponentDescriptor
title
- The window title.public String getTabTitle()
getTabTitle
in interface PageComponentDescriptor
public void setTabTitle(String tabTitle)
setTabTitle
in interface PageComponentDescriptor
tabTitle
- The window tab-title.public String getDescription()
getDescription
in interface PageComponentDescriptor
public void setDescription(String description)
setDescription
in interface PageComponentDescriptor
description
- The window description.public String getToolBarId()
ToolViewDescriptor
null
, the associated "show view" command will be placed in the
default tool bar (ID="viewsToolBar").getToolBarId
in interface ToolViewDescriptor
ToolViewDescriptor.createShowViewCommand(ApplicationPage)
public void setToolBarId(String toolBarId)
setToolBarId
in interface ToolViewDescriptor
toolBarId
- The ID of the tool bar.ToolViewDescriptor.getToolBarId()
public Icon getSmallIcon()
getSmallIcon
in interface PageComponentDescriptor
null
if not set.public Icon getLargeIcon()
getLargeIcon
in interface PageComponentDescriptor
null
if not set.public void setSmallIcon(Icon smallIcon)
setSmallIcon
in interface PageComponentDescriptor
smallIcon
- The small window icon or null
if not set.public void setLargeIcon(Icon largeIcon)
setLargeIcon
in interface PageComponentDescriptor
largeIcon
- The large window icon or null
if not set.public char getMnemonic()
getMnemonic
in interface ToolViewDescriptor
public void setMnemonic(char mnemonic)
setMnemonic
in interface ToolViewDescriptor
mnemonic
- The mnemonic.public KeyStroke getAccelerator()
getAccelerator
in interface ToolViewDescriptor
public void setAccelerator(KeyStroke accelerator)
setAccelerator
in interface ToolViewDescriptor
accelerator
- The accelerator.public ToolViewDescriptor.State getInitState()
getInitState
in interface ToolViewDescriptor
public void setInitState(ToolViewDescriptor.State initState)
setInitState
in interface ToolViewDescriptor
initState
- The initial state.public ToolViewDescriptor.DockSide getInitSide()
getInitSide
in interface ToolViewDescriptor
public void setInitSide(ToolViewDescriptor.DockSide initSide)
setInitSide
in interface ToolViewDescriptor
initSide
- The initial side.public int getInitIndex()
getInitIndex
in interface ToolViewDescriptor
public void setInitIndex(int initIndex)
setInitIndex
in interface ToolViewDescriptor
initIndex
- The initial index.public int getDockedWidth()
getDockedWidth
in interface ToolViewDescriptor
public void setDockedWidth(int dockedWidth)
setDockedWidth
in interface ToolViewDescriptor
dockedWidth
- The docked width in pixels.public int getDockedHeight()
getDockedHeight
in interface ToolViewDescriptor
public void setDockedHeight(int dockedHeight)
setDockedHeight
in interface ToolViewDescriptor
dockedHeight
- The docked height in pixels.public Rectangle getFloatingBounds()
getFloatingBounds
in interface ToolViewDescriptor
public void setFloatingBounds(Rectangle floatingBounds)
setFloatingBounds
in interface ToolViewDescriptor
floatingBounds
- The bounds of the tool window when in floating mode.public Dimension getPreferredSize()
getPreferredSize
in interface PageComponentDescriptor
public void setPreferredSize(Dimension preferredSize)
setPreferredSize
in interface PageComponentDescriptor
preferredSize
- The preferred size.public boolean isHidable()
isHidable
in interface ToolViewDescriptor
true
if the window is hidable, false
otherwise.public void setHidable(boolean state)
setHidable
in interface ToolViewDescriptor
state
- true
if the window is hidable, false
otherwise.public boolean isDockable()
isDockable
in interface ToolViewDescriptor
true
if the window is dockable, false
otherwise.public void setDockable(boolean state)
setDockable
in interface ToolViewDescriptor
state
- true
if the window is dockable, false
otherwise.public boolean isFloatable()
isFloatable
in interface ToolViewDescriptor
true
if the window is floatable, false
otherwise.public void setFloatable(boolean state)
setFloatable
in interface ToolViewDescriptor
state
- true
if the window is floatable, false
otherwise.public boolean isAutohidable()
isAutohidable
in interface ToolViewDescriptor
true
if the window is auto-hidable, false
otherwise.public void setAutohidable(boolean state)
setAutohidable
in interface ToolViewDescriptor
state
- true
if the window is auto-hidable, false
otherwise.public boolean isMaximizable()
isMaximizable
in interface PageComponentDescriptor
true
if the window is maximizable, false
otherwise.public void setMaximizable(boolean state)
setMaximizable
in interface PageComponentDescriptor
state
- true
if the window is maximizable, false
otherwise.public boolean isVisible()
isVisible
in interface PageComponentDescriptor
true
if the window is visible, false
otherwise.public void setVisible(boolean state)
setVisible
in interface PageComponentDescriptor
state
- true
if the window shall become visible, false
otherwise.public boolean isEnabled()
isEnabled
in interface PageComponentDescriptor
true
if the window is enabled, false
otherwise.public void setEnabled(boolean state)
setEnabled
in interface PageComponentDescriptor
state
- true
if the window is enabled, false
otherwise.public void addPropertyChangeListener(PropertyChangeListener listener)
addPropertyChangeListener
in interface com.bc.ceres.binding.PropertyChangeEmitter
public void addPropertyChangeListener(String propertyName, PropertyChangeListener listener)
addPropertyChangeListener
in interface com.bc.ceres.binding.PropertyChangeEmitter
public void removePropertyChangeListener(PropertyChangeListener listener)
removePropertyChangeListener
in interface com.bc.ceres.binding.PropertyChangeEmitter
public void removePropertyChangeListener(String propertyName, PropertyChangeListener listener)
removePropertyChangeListener
in interface com.bc.ceres.binding.PropertyChangeEmitter
public PageComponent createPageComponent()
createPageComponent
in interface PageComponentDescriptor
protected ToolView createToolView()
public Command createShowViewCommand(ApplicationPage applicationPage)
createShowViewCommand
in interface ToolViewDescriptor
applicationPage
- The windowToolViewDescriptor.getToolBarId()
public void configure(com.bc.ceres.core.runtime.ConfigurationElement config) throws com.bc.ceres.core.CoreException
configure
in interface com.bc.ceres.core.runtime.ConfigurableExtension
com.bc.ceres.core.CoreException
Copyright © 2002–2014 Brockmann Consult GmbH. All rights reserved.