com.highqsoft.fwk.util

Interface CommandContainerInterface

All Superinterfaces:

java.awt.datatransfer.ClipboardOwner, FwkCommandInterface, FwkControlledByInterface, FwkControllerInterface, FwkDescriptionInterface, FwkDOMHandlerInterface, FwkInstructionInterface, FwkInterface, FwkPresentationInterface, FwkPropertyChangeInterface, FwkTransferableInterface, java.io.Serializable, java.awt.datatransfer.Transferable

All Known Implementing Classes:

CommandContainer, DataManagerCommandContainer, MEDDataGenerators, MEDDataManipulators, MEDMarkerGenerators, MEDMouseBehaviors, MEDMousePointers, MEDPlotControls

public interface CommandContainerInterface
extends FwkCommandInterface, FwkDOMHandlerInterface, FwkControllerInterface, FwkDescriptionInterface

The Command Container interface.

Since:

$Date: 2017/04/06 13:29:08 $

Version:

$Revision: 1.11 $

Author:

Andreas Hofmann

See Also:

Field Summary

Fields inherited from interface com.highqsoft.interfaces.fwk.FwkCommandInterface

CONTROLLER_PROPERTY, MENU_REASON_CANCELED, MENU_REASON_DESELECTED, MENU_REASON_SELECTED

Fields inherited from interface com.highqsoft.interfaces.fwk.FwkDescriptionInterface

AUTHOR, BUILDNR, COMPANY, COPYRIGHT, DATE_FORMAT, DEFAULT_ICON, DESCRIPTION, INTERNET, LARGE_ICON, LARGE_KEY_EXT, LARGE_OPAQUE_ICON, LARGE_OPAQUE_KEY_EXT, OPAQUE_ICON, OPAQUE_KEY_EXT, RCS_DATE_FORMAT, SUPPORT_EMAIL, TITLE_NAME

Method Summary

Methods

Modifier and Type	Method and Description
javax.swing.JToolBar	addToolBar(FwkPanelInterface panel) Retrieves a toolbar from command object array.
javax.swing.JToolBar	addToolBar(FwkPanelInterface panel, java.lang.String position, int alignment) Retrieves a toolbar from command object array.
java.awt.Color	getColor() Get the color.
int	getToolBarAlignment() Get the toolbar alignment.
java.lang.String	getToolBarPosition() Get the toolbar position.
java.lang.String	getToolTipText() Get the tool tip text belong to the tool tip text key.
java.lang.String	getToolTipTextKey() Get the tool tip text property key.
void	setColor(java.awt.Color color) Set the color.
void	setDefaultCommands() Set the default command for that container.
void	setToolBarAlignment(int alignment) Set the toolbar alignment.
void	setToolBarPosition(java.lang.String position) Set the position of the toolbar.
void	setToolTipTextKey(java.lang.String key) Set the tool tip text key.

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkCommandInterface

addActionListener, addMenuListener, execute, getActionListenerArray, getButtonClass, getCommandName, getHelpID, getIcon, getIconKey, getMenuEventEnabled, getMenuItemClass, getMenuListenerArray, getMnemonic, getProperties, getProperty, getRadioGroupState, getSensitivity, getSeparator, getText, getTextKey, getToggle, getToggleState, getToolBarEnabled, getToolTipKey, getVisibility, hasActionListeners, hasMenuListeners, isParent, menuSelect, register, registeredObjects, registrySize, removeActionListener, removeMenuListener, setAsParent, setButtonClass, setCommandName, setHelpID, setIcon, setIconKey, setMenuEventEnabled, setMenuItemClass, setMnemonic, setProperty, setRadioGroupState, setSensitivity, setSeparator, setText, setTextKey, setToggle, setToggleState, setToolBarEnabled, setToolTipKey, setToolTipText, setVisibility, unregister

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkInstructionInterface

addCommand, addCommand, addToGroup, addToGroup, clearCommands, commandsAvailable, deleteGroup, getCommand, getCommands, getGroup, groupExists, removeCommand, removeFromGroup, setCommands

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkPresentationInterface

getPresentationString, getPresentationString

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkInterface

getVersion, release

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkControlledByInterface

getController, setController

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkPropertyChangeInterface

addPropertyChangeListener, addPropertyChangeListener, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getPropertyChangeArray, getPropertyChangeListenerArray, getPropertyChangeListenerArray, isPropertyChangeEventSuspended, removePropertyChangeListener, removePropertyChangeListener, setSource, suspendPropertyChangeEvents

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkDOMHandlerInterface

getCompany, readConstructor, readFromDOM, readingDOM, readingDOM, writeConstructor, writeToDOM, writeToXML

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkControllerInterface

destroyController

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkDescriptionInterface

getAuthor, getBuild, getClassName, getCompanyInternetAddress, getCopyright, getCreationDate, getCreationDate, getDateFormatString, getDescription, getIcon, getIcon, getIconKey, getIconKey, getName, getPresentationString, getPresentationString, getSupportEMail, getTitle, getTitleName, setAuthor, setBuild, setClassName, setCompany, setCompanyInternetAddress, setCopyright, setCreationDate, setCreationDate, setDateFormatString, setDescription, setDescriptor, setIcon, setIcon, setIconKey, setIconKey, setName, setSupportEMail, setTitleName

Methods inherited from interface java.awt.datatransfer.Transferable

getTransferData, getTransferDataFlavors, isDataFlavorSupported

Methods inherited from interface java.awt.datatransfer.ClipboardOwner

lostOwnership

Method Detail

getColor

java.awt.Color getColor()

Get the color.

Returns:

The color.

setColor

void setColor(java.awt.Color color)

Set the color.

Parameters:

color - The color.

setToolTipTextKey

void setToolTipTextKey(java.lang.String key)

Set the tool tip text key.

Parameters:

key - The tool tip text property key.

getToolTipTextKey

java.lang.String getToolTipTextKey()

Get the tool tip text property key.

Returns:

the key.

getToolTipText

java.lang.String getToolTipText()

Get the tool tip text belong to the tool tip text key.

Specified by:

getToolTipText in interface FwkCommandInterface

Returns:

the tool tip.

See Also:

FwkCommandInterface.setToolTipText(String), FwkCommandInterface.getToolTipKey()

setDefaultCommands

void setDefaultCommands()

Set the default command for that container.

setToolBarPosition

void setToolBarPosition(java.lang.String position)

Set the position of the toolbar.

Parameters:

position - The border layout position constants. Use NORTH, EAST, SOUTH or WEST only. CENTER is not supported and will be ignored.

getToolBarPosition

java.lang.String getToolBarPosition()

Get the toolbar position.

Returns:

the toolbar position.

setToolBarAlignment

void setToolBarAlignment(int alignment)

Set the toolbar alignment.

Parameters:

alignment - The alignment of the flow layout.

getToolBarAlignment

int getToolBarAlignment()

Get the toolbar alignment.

Returns:

The alignment of the flow layout.

addToolBar

javax.swing.JToolBar addToolBar(FwkPanelInterface panel,
                              java.lang.String position,
                              int alignment)

Retrieves a toolbar from command object array. This method loops through all available command a create buttons onto the toolbar. If the toolbar doesn't exist, it will be created.

Parameters:

panel - The to that the toolbar should be added. It maust have a BorderLayout

alignment - The alignment of the flow layout.

Returns:

The created toolbar or null, if there are no commands.

addToolBar

javax.swing.JToolBar addToolBar(FwkPanelInterface panel)

Retrieves a toolbar from command object array. This method loops through all available command a create buttons onto the toolbar. If the toolbar doesn't exist, it will be created.

Parameters:

panel - The to that the toolbar should be added. It maust have a BorderLayout

Returns:

The created toolbar or null, if there are no commands.