com.highqsoft.fwk.util

Class CommandContainer

java.lang.Object

com.highqsoft.fwk.Fwk

com.highqsoft.fwk.FwkDescription

com.highqsoft.fwk.FwkPropertyChange

com.highqsoft.fwk.FwkCommand

com.highqsoft.fwk.util.CommandContainer

All Implemented Interfaces:

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

Direct Known Subclasses:

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

public abstract class CommandContainer
extends FwkCommand
implements CommandContainerInterface

The abstract implmentation of an CommandContainerInterface.

Since:

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

Version:

$Revision: 1.14 $

Author:

Andreas Hofmann

See Also:

, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	CommandContainer.ToolBarMouseListener The mouse listener on the toolbar.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	author The author name.
protected java.lang.String	buildnr The build number.
protected java.awt.Color	color The color.
protected java.lang.String	company The company name.
protected FwkControllerInterface	controller The controller.
protected java.lang.String	copyright The copyright string.
protected java.util.Date	creationDate The creation date.
protected java.lang.String	dateFormatString The date format string.
protected java.lang.String	description The description of the application.
protected java.lang.String	eMail The support email.
protected FwkIconInterface[]	icon
protected int	iconCount The icon array.
protected java.lang.String[]	iconKey The icon keyword.
protected java.lang.String	internetAddress The internet address of the company.
protected java.lang.String	name
protected boolean	readingDOM
protected java.lang.String	titleName
protected int	toolBarAlignment The toolbar alignment.
protected java.lang.String	toolBarPosition The toolbar position.
protected java.lang.String	toolTipTextKey The tool tip text key.
static java.lang.String	version

Fields inherited from class com.highqsoft.fwk.FwkCommand

actionListeners, buttonClass, commandName, helpID, instruction, menuEventEnabled, menuItemClass, menuListeners, mnemonic, properties, radioGroupState, registry, sensitive, separator, text, textKey, toggle, toggleState, toolBarEnabled, toolTipKey, toolTipText, visible

Fields inherited from class com.highqsoft.fwk.FwkPropertyChange

source

Fields inherited from class com.highqsoft.fwk.FwkDescription

className, FWK_ICON, FWK_ICON_ARRAY, FWK_ICON_BG, FWK_ICON_BG_ARRAY, FWK_ICON_BG_LARGE, FWK_ICON_BG_LARGE_ARRAY, FWK_ICON_LARGE, FWK_ICON_LARGE_ARRAY, ICON

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

Constructor Summary

Constructors

Constructor and Description
CommandContainer() The constructor.
CommandContainer(FwkControllerInterface controller) The constructor.

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.
protected FwkCommandInterface	createCommand(java.lang.String className) Instanciate command
boolean	destroyController() Destroy the controller.
java.lang.String	getAuthor() Get the author name.
java.lang.String	getBuild() Get the build number.
java.awt.Color	getColor() Get the color.
FwkCommandInterface[]	getCommands() Get the array containing the command.
java.lang.String	getCompany() Get the company name.
java.lang.String	getCompanyInternetAddress() Get the internet address of the company.
protected FwkCommandInterface	getContainerCommand(java.lang.String className) Get a container command.
FwkControllerInterface	getController() Return the controller.
java.lang.String	getCopyright() Get the copyright.
java.lang.String	getCreationDate() Get the creation date.
java.lang.String	getCreationDate(java.lang.String formatString) Get the creation date.
java.lang.String	getDateFormatString() Get the date format string.
java.lang.String	getDescription() Get the description.
FwkIconInterface	getIcon() Get the icon image.
FwkIconInterface	getIcon(int type) Get the image icon of the application
java.lang.String	getIconKey() Get the property keyword of the icon.
java.lang.String	getIconKey(int type) Get the property keyword of the icon.
java.lang.String	getName() Return the name of the ASAM-FWK object.
java.lang.String	getPresentationString() Retrieves the representation string.
java.lang.String	getPresentationString(java.util.Locale locale) Retrieves the representation string.
abstract java.lang.String	getPropertyGroupName() Get the property group name to find the commands.
java.lang.String	getSupportEMail() Get the support e-mail.
java.lang.String	getTitle() Get the title.
java.lang.String	getTitleName() Get the title name.
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.
java.lang.Object	getTransferData(java.awt.datatransfer.DataFlavor flavor) Returns an object which represents the data to be transferred.
java.awt.datatransfer.DataFlavor[]	getTransferDataFlavors() Returns an array of DataFlavor objects indicating the flavors the data can be provided in.
java.lang.String	getVersion() Return the version string of the FWK component.
boolean	isDataFlavorSupported(java.awt.datatransfer.DataFlavor flavor) Returns whether or not the specified data flavor is supported for this object.
void	lostOwnership(java.awt.datatransfer.Clipboard clipboard, java.awt.datatransfer.Transferable contents) Notifies this object that it is no longer the owner of the contents of the clipboard.
java.lang.Object	readConstructor(org.w3c.dom.Document document, org.w3c.dom.Element node) Read a construtor dom node.
void	readFromDOM(org.w3c.dom.Document doc, org.w3c.dom.Element element) Read from DOM
boolean	readingDOM() Get the DOM reading flag.
void	readingDOM(boolean flag) Set a flag that the object is currently reading the DOM.
void	setAuthor(java.lang.String author) Set the author name.
void	setBuild(java.lang.String buildnr) Set the build number.
void	setColor(java.awt.Color color) Set the color.
void	setCompany(java.lang.String company) Set the company name.
void	setCompanyInternetAddress(java.lang.String address) Set the internet address of the company.
void	setController(FwkControllerInterface controller) Set the controller.
void	setCopyright(java.lang.String copyright) Set the copyright.
void	setCreationDate(java.lang.String dateString) Set the Date of the application.
void	setCreationDate(java.lang.String dateString, java.lang.String formatString) Set the Date of the application.
void	setDateFormatString(java.lang.String formatString) Set the Date format string.
void	setDefaultCommands() Set the default command for that container.
void	setDescription(java.lang.String description) Set the description of the application.
void	setDescriptor(FwkDescriptionInterface descriptor) Initialize the object with values of the given FwkDescription.
void	setIcon(FwkIconInterface icon) Set the icon image.
void	setIcon(FwkIconInterface icon, int type) Set the image icon of the application
void	setIconKey(java.lang.String key) Set the property keyword of the icon.
void	setIconKey(java.lang.String key, int type) Set the property keyword of the icon.
void	setName(java.lang.String name) Set the name of the ASAM-FWK object.
void	setSupportEMail(java.lang.String eMail) Get the support e-mail.
void	setTitleName(java.lang.String titleName) Set the title of the application.
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.
java.lang.String	toString() Get a string representation of the object.
org.w3c.dom.Element	writeConstructor(org.w3c.dom.Document document, FwkXmlDtdInterface dtd, org.w3c.dom.Node node, java.util.Map classProperties) Write a construtor dom node.
org.w3c.dom.Element	writeToDOM(org.w3c.dom.Document document, FwkXmlDtdInterface dtd, org.w3c.dom.Node node, java.util.Map classProperties) Write the container as child to the given DOM node.
boolean	writeToXML(java.lang.String filename, boolean validate) Writes the canvas to an XML file.

Methods inherited from class com.highqsoft.fwk.FwkCommand

addActionListener, addCommand, addCommand, addMenuListener, addToGroup, addToGroup, clearCommands, commandsAvailable, deleteGroup, execute, getActionListenerArray, getButtonClass, getCommand, getCommandName, getGroup, getHelpID, getMenuEventEnabled, getMenuItemClass, getMenuListenerArray, getMnemonic, getProperties, getProperty, getRadioGroupState, getSensitivity, getSeparator, getText, getTextKey, getToggle, getToggleState, getToolBarEnabled, getToolTipKey, getVisibility, groupExists, hasActionListeners, hasMenuListeners, isParent, menuSelect, register, registeredObjects, registrySize, removeActionListener, removeCommand, removeFromGroup, removeMenuListener, setAsParent, setButtonClass, setCommandName, setCommands, setHelpID, setMenuEventEnabled, setMenuItemClass, setMnemonic, setProperty, setRadioGroupState, setSensitivity, setSeparator, setText, setTextKey, setToggle, setToggleState, setToolBarEnabled, setToolTipKey, setToolTipText, setVisibility, unregister

Methods inherited from class com.highqsoft.fwk.FwkPropertyChange

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

Methods inherited from class com.highqsoft.fwk.FwkDescription

getClassName, setClassName

Methods inherited from class com.highqsoft.fwk.Fwk

getNiceVersion, release

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

addActionListener, addMenuListener, execute, getActionListenerArray, getButtonClass, getCommandName, getHelpID, 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, 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, getGroup, groupExists, removeCommand, removeFromGroup, setCommands

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

release

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.FwkDescriptionInterface

getClassName, setClassName

Field Detail

controller

protected FwkControllerInterface controller

The controller.

color

protected java.awt.Color color

The color.

toolTipTextKey

protected java.lang.String toolTipTextKey

The tool tip text key.

toolBarPosition

protected java.lang.String toolBarPosition

The toolbar position.

toolBarAlignment

protected int toolBarAlignment

The toolbar alignment.

readingDOM

protected boolean readingDOM

version

public static final java.lang.String version

See Also:

Constant Field Values

author

protected java.lang.String author

The author name.

buildnr

protected java.lang.String buildnr

The build number.

company

protected java.lang.String company

The company name.

copyright

protected java.lang.String copyright

The copyright string.

creationDate

protected java.util.Date creationDate

The creation date.

dateFormatString

protected java.lang.String dateFormatString

The date format string.

description

protected java.lang.String description

The description of the application.

eMail

protected java.lang.String eMail

The support email.

iconCount

protected final int iconCount

The icon array.

See Also:

Constant Field Values

icon

protected FwkIconInterface[] icon

iconKey

protected java.lang.String[] iconKey

The icon keyword.

internetAddress

protected java.lang.String internetAddress

The internet address of the company.

titleName

protected java.lang.String titleName

name

protected java.lang.String name

Constructor Detail

CommandContainer

public CommandContainer()

The constructor.

CommandContainer

public CommandContainer(FwkControllerInterface controller)

The constructor.

Method Detail

getVersion

public java.lang.String getVersion()

Description copied from interface: FwkInterface

Return the version string of the FWK component.

Specified by:

getVersion in interface FwkInterface

Overrides:

getVersion in class FwkCommand

setController

public void setController(FwkControllerInterface controller)

Set the controller.

Specified by:

setController in interface FwkControlledByInterface

Overrides:

setController in class FwkCommand

Parameters:

controller - the new controller.

See Also:

FwkCommand.getController(), #FwkMenuFactory

getController

public FwkControllerInterface getController()

Return the controller.

Specified by:

getController in interface FwkControlledByInterface

Overrides:

getController in class FwkCommand

Returns:

The controller.

See Also:

#setController(Object), #FwkMenuFactory

readConstructor

public java.lang.Object readConstructor(org.w3c.dom.Document document,
                               org.w3c.dom.Element node)

Read a construtor dom node.

Specified by:

readConstructor in interface FwkDOMHandlerInterface

Parameters:

document - The documnent Object Model.

dtd - The dtd descriptor.

node - The node.

classProperties - Map the contains the writable object properties. May be null.

readFromDOM

public void readFromDOM(org.w3c.dom.Document doc,
               org.w3c.dom.Element element)

Read from DOM

Specified by:

readFromDOM in interface FwkDOMHandlerInterface

writeConstructor

public org.w3c.dom.Element writeConstructor(org.w3c.dom.Document document,
                                   FwkXmlDtdInterface dtd,
                                   org.w3c.dom.Node node,
                                   java.util.Map classProperties)

Write a construtor dom node.

Specified by:

writeConstructor in interface FwkDOMHandlerInterface

Parameters:

document - The documnent Object Model.

dtd - The dtd descriptor.

node - The node.

classProperties - Map the contains the writable object properties. May be null.

Returns:

the create document element.

writeToDOM

public org.w3c.dom.Element writeToDOM(org.w3c.dom.Document document,
                             FwkXmlDtdInterface dtd,
                             org.w3c.dom.Node node,
                             java.util.Map classProperties)

Write the container as child to the given DOM node.

Specified by:

writeToDOM in interface FwkDOMHandlerInterface

Parameters:

document - The documnent Object Model.

node - The parent node.

classProperties - Map the contains the writable object properties. May be null.

Returns:

The create document element.

writeToXML

public boolean writeToXML(java.lang.String filename,
                 boolean validate)

Writes the canvas to an XML file.

Specified by:

writeToXML in interface FwkDOMHandlerInterface

Parameters:

filename - The name of the xml file.

validate - Write a validated cml file.

readingDOM

public void readingDOM(boolean flag)

Set a flag that the object is currently reading the DOM.

Specified by:

readingDOM in interface FwkDOMHandlerInterface

Parameters:

flag - true if the object reads currently fom DOM.

readingDOM

public boolean readingDOM()

Get the DOM reading flag.

Specified by:

readingDOM in interface FwkDOMHandlerInterface

Returns:

true if the object reads currently fom DOM.

getColor

public java.awt.Color getColor()

Get the color.

Specified by:

getColor in interface CommandContainerInterface

Returns:

The color.

setColor

public void setColor(java.awt.Color color)

Set the color.

Specified by:

setColor in interface CommandContainerInterface

Parameters:

color - The color.

setToolTipTextKey

public void setToolTipTextKey(java.lang.String key)

Set the tool tip text key.

Specified by:

setToolTipTextKey in interface CommandContainerInterface

Parameters:

key - The tool tip text property key.

getToolTipTextKey

public java.lang.String getToolTipTextKey()

Get the tool tip text property key.

Specified by:

getToolTipTextKey in interface CommandContainerInterface

Returns:

the key.

getToolTipText

public java.lang.String getToolTipText()

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

Specified by:

getToolTipText in interface CommandContainerInterface

Specified by:

getToolTipText in interface FwkCommandInterface

Overrides:

getToolTipText in class FwkCommand

Returns:

the tool tip.

See Also:

FwkCommand.setToolTipText(String), FwkCommand.getToolTipKey()

getCommands

public FwkCommandInterface[] getCommands()

Get the array containing the command.

Specified by:

getCommands in interface FwkInstructionInterface

Overrides:

getCommands in class FwkCommand

Returns:

the array containing the command.

createCommand

protected FwkCommandInterface createCommand(java.lang.String className)

Instanciate command

Parameters:

className - The name of the class.

Returns:

the command object or null if not possible. If it is not possible to create the object it creates an entry in the system event log, but doesn't throw an exception.

getContainerCommand

protected FwkCommandInterface getContainerCommand(java.lang.String className)

Get a container command. This method will be called before the container tries to instanciate the given class.

Parameters:

className - The name of the class.

Returns:

the command object or null if not available.

setToolBarPosition

public void setToolBarPosition(java.lang.String position)

Set the position of the toolbar.

Specified by:

setToolBarPosition in interface CommandContainerInterface

Parameters:

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

getToolBarPosition

public java.lang.String getToolBarPosition()

Get the toolbar position.

Specified by:

getToolBarPosition in interface CommandContainerInterface

Returns:

the toolbar position.

setToolBarAlignment

public void setToolBarAlignment(int alignment)

Set the toolbar alignment.

Specified by:

setToolBarAlignment in interface CommandContainerInterface

Parameters:

alignment - The alignment of the flow layout.

getToolBarAlignment

public int getToolBarAlignment()

Get the toolbar alignment.

Specified by:

getToolBarAlignment in interface CommandContainerInterface

Returns:

The alignment of the flow layout.

addToolBar

public 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.

Specified by:

addToolBar in interface CommandContainerInterface

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

public 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.

Specified by:

addToolBar in interface CommandContainerInterface

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.

getAuthor

public java.lang.String getAuthor()

Get the author name.

Specified by:

getAuthor in interface FwkDescriptionInterface

Overrides:

getAuthor in class FwkDescription

Returns:

The name of the author.

See Also:

setAuthor(String)

getBuild

public java.lang.String getBuild()

Get the build number.

Specified by:

getBuild in interface FwkDescriptionInterface

Overrides:

getBuild in class FwkDescription

Returns:

The string representing the build number.

See Also:

#setBuild(int)

getCompany

public java.lang.String getCompany()

Get the company name.

Specified by:

getCompany in interface FwkDescriptionInterface

Specified by:

getCompany in interface FwkDOMHandlerInterface

Overrides:

getCompany in class FwkDescription

Returns:

The name of the company.

See Also:

setCompany(String)

getCompanyInternetAddress

public java.lang.String getCompanyInternetAddress()

Get the internet address of the company.

Specified by:

getCompanyInternetAddress in interface FwkDescriptionInterface

Overrides:

getCompanyInternetAddress in class FwkDescription

Returns:

A string containing the internet address of the company.

getCopyright

public java.lang.String getCopyright()

Get the copyright.

Specified by:

getCopyright in interface FwkDescriptionInterface

Overrides:

getCopyright in class FwkDescription

Returns:

The copyright string.

See Also:

setCopyright(String)

getCreationDate

public java.lang.String getCreationDate()

Get the creation date.

Specified by:

getCreationDate in interface FwkDescriptionInterface

Overrides:

getCreationDate in class FwkDescription

Returns:

The date of the creation.

See Also:

#setCreationDate(Date)

getCreationDate

public java.lang.String getCreationDate(java.lang.String formatString)

Get the creation date.

Specified by:

getCreationDate in interface FwkDescriptionInterface

Overrides:

getCreationDate in class FwkDescription

Parameters:

formatString - The date format string

Returns:

The date of the creation.

See Also:

#java.text.SimpleDateFormat, #setCreationDate(Date)

getDateFormatString

public java.lang.String getDateFormatString()

Get the date format string.

Specified by:

getDateFormatString in interface FwkDescriptionInterface

Overrides:

getDateFormatString in class FwkDescription

Returns:

The date format string.

getDescription

public java.lang.String getDescription()

Get the description.

Specified by:

getDescription in interface FwkDescriptionInterface

Overrides:

getDescription in class FwkDescription

Returns:

The description of the application.

See Also:

setDescription(String)

getIcon

public FwkIconInterface getIcon()

Get the icon image.

Specified by:

getIcon in interface FwkCommandInterface

Specified by:

getIcon in interface FwkDescriptionInterface

Overrides:

getIcon in class FwkCommand

Returns:

The icon of the application.

See Also:

setIcon(FwkIconInterface)

getIcon

public FwkIconInterface getIcon(int type)

Get the image icon of the application

Specified by:

getIcon in interface FwkDescriptionInterface

Overrides:

getIcon in class FwkDescription

Parameters:

type - The type of the icon, use the predefined values (see above).

Returns:

Icon

See Also:

#setIcon(Icon)

getIconKey

public java.lang.String getIconKey()

Get the property keyword of the icon.

Specified by:

getIconKey in interface FwkCommandInterface

Specified by:

getIconKey in interface FwkDescriptionInterface

Overrides:

getIconKey in class FwkCommand

Returns:

The keyword for the icon.

See Also:

#getIconImage()

getIconKey

public java.lang.String getIconKey(int type)

Get the property keyword of the icon.

Specified by:

getIconKey in interface FwkDescriptionInterface

Overrides:

getIconKey in class FwkDescription

Parameters:

type - The type of the icon, use the predefined values (see above).

Returns:

The keyword for the icon.

getName

public java.lang.String getName()

Return the name of the ASAM-FWK object.

Specified by:

getName in interface FwkDescriptionInterface

Overrides:

getName in class FwkDescription

Returns:

The name of the object.

getPresentationString

public java.lang.String getPresentationString(java.util.Locale locale)

Retrieves the representation string. The presentation string is a complete representation of the object including its data. This feature is required for copy/paste and drag/drop operations. The locale parameter allows to make the representation string locale language dependent.

Specified by:

getPresentationString in interface FwkDescriptionInterface

Specified by:

getPresentationString in interface FwkPresentationInterface

Overrides:

getPresentationString in class FwkDescription

Parameters:

locale - The Locale object or null.

Returns:

The localized presentation string.

getPresentationString

public java.lang.String getPresentationString()

Retrieves the representation string. The presentation string is a complete representation of the object including its data. This feature is required for copy/paste and drag/drop operations. The locale parameter allows to make the representation string locale language dependent.

Specified by:

getPresentationString in interface FwkDescriptionInterface

Specified by:

getPresentationString in interface FwkPresentationInterface

Overrides:

getPresentationString in class FwkDescription

Returns:

The presentation string.

getSupportEMail

public java.lang.String getSupportEMail()

Get the support e-mail.

Specified by:

getSupportEMail in interface FwkDescriptionInterface

Overrides:

getSupportEMail in class FwkDescription

Returns:

A string containing the support e-mail.

getTitle

public java.lang.String getTitle()

Get the title.

Specified by:

getTitle in interface FwkDescriptionInterface

Overrides:

getTitle in class FwkDescription

Returns:

The title of the application.

getTitleName

public java.lang.String getTitleName()

Get the title name.

Specified by:

getTitleName in interface FwkDescriptionInterface

Overrides:

getTitleName in class FwkDescription

Returns:

The title name of the application.

See Also:

setName(String)

setAuthor

public void setAuthor(java.lang.String author)

Set the author name.

Specified by:

setAuthor in interface FwkDescriptionInterface

Overrides:

setAuthor in class FwkDescription

Parameters:

author - The name of the author.

See Also:

getAuthor()

setBuild

public void setBuild(java.lang.String buildnr)

Set the build number.

Specified by:

setBuild in interface FwkDescriptionInterface

Overrides:

setBuild in class FwkDescription

Parameters:

buildnr - The string representing the build number.

See Also:

getBuild()

setCompany

public void setCompany(java.lang.String company)

Set the company name.

Specified by:

setCompany in interface FwkDescriptionInterface

Overrides:

setCompany in class FwkDescription

Parameters:

company - The name of the company.

See Also:

getCompany()

setCompanyInternetAddress

public void setCompanyInternetAddress(java.lang.String address)

Set the internet address of the company.

Specified by:

setCompanyInternetAddress in interface FwkDescriptionInterface

Overrides:

setCompanyInternetAddress in class FwkDescription

setCopyright

public void setCopyright(java.lang.String copyright)

Set the copyright.

Specified by:

setCopyright in interface FwkDescriptionInterface

Overrides:

setCopyright in class FwkDescription

Parameters:

The - copyright string.

See Also:

getCopyright()

setCreationDate

public void setCreationDate(java.lang.String dateString,
                   java.lang.String formatString)

Set the Date of the application. The default input format string FwkDescription.RCS_DATE_FORMAT. The default output format string FwkDescription.DATE_FORMAT.

Specified by:

setCreationDate in interface FwkDescriptionInterface

Overrides:

setCreationDate in class FwkDescription

Parameters:

dateString - The Date of the application.

formatString - The format string.

See Also:

#java.text.SimpleDateFormat, getCreationDate()

setCreationDate

public void setCreationDate(java.lang.String dateString)

Set the Date of the application.

Specified by:

setCreationDate in interface FwkDescriptionInterface

Overrides:

setCreationDate in class FwkDescription

Parameters:

dateString - The Date of the application.

See Also:

#java.text.SimpleDateFormat, getCreationDate()

setDateFormatString

public void setDateFormatString(java.lang.String formatString)

Set the Date format string.

Specified by:

setDateFormatString in interface FwkDescriptionInterface

Overrides:

setDateFormatString in class FwkDescription

Parameters:

formatString - The format string.

See Also:

#java.text.SimpleDateFormat, getCreationDate()

setDescription

public void setDescription(java.lang.String description)

Set the description of the application.

Specified by:

setDescription in interface FwkDescriptionInterface

Overrides:

setDescription in class FwkDescription

Parameters:

description - The description of the application.

See Also:

getDescription()

setDescriptor

public void setDescriptor(FwkDescriptionInterface descriptor)
                   throws FwkException

Initialize the object with values of the given FwkDescription.

Specified by:

setDescriptor in interface FwkDescriptionInterface

Overrides:

setDescriptor in class FwkDescription

Parameters:

descriptor - The FwkDescription from that the value should be copied.

Throws:

FwkException

setIcon

public void setIcon(FwkIconInterface icon)

Set the icon image.

Specified by:

setIcon in interface FwkCommandInterface

Specified by:

setIcon in interface FwkDescriptionInterface

Overrides:

setIcon in class FwkCommand

Parameters:

The - icon of the application.

See Also:

getIcon()

setIcon

public void setIcon(FwkIconInterface icon,
           int type)

Set the image icon of the application

Specified by:

setIcon in interface FwkDescriptionInterface

Overrides:

setIcon in class FwkDescription

Parameters:

icon - The icon to be set.

type - The type of the icon, use predefined values defined above. If this value is out of range, no icon will be set.

See Also:

getIcon()

setIconKey

public void setIconKey(java.lang.String key)

Set the property keyword of the icon.

Specified by:

setIconKey in interface FwkCommandInterface

Specified by:

setIconKey in interface FwkDescriptionInterface

Overrides:

setIconKey in class FwkCommand

Parameters:

key - The keyword for the icon.

See Also:

FwkCommand.getIconKey(), FwkCommand.getIcon()

setIconKey

public void setIconKey(java.lang.String key,
              int type)

Set the property keyword of the icon.

Specified by:

setIconKey in interface FwkDescriptionInterface

Overrides:

setIconKey in class FwkDescription

Parameters:

key - The keyword for the icon.

type - The type of the icon, use predefined values defined above.

setName

public void setName(java.lang.String name)

Set the name of the ASAM-FWK object.

Specified by:

setName in interface FwkDescriptionInterface

Overrides:

setName in class FwkDescription

Parameters:

name - The name of the object.

See Also:

getName()

setSupportEMail

public void setSupportEMail(java.lang.String eMail)

Get the support e-mail.

Specified by:

setSupportEMail in interface FwkDescriptionInterface

Overrides:

setSupportEMail in class FwkDescription

Parameters:

eMail - A string containing the support e-mail.

setTitleName

public void setTitleName(java.lang.String titleName)

Set the title of the application.

Specified by:

setTitleName in interface FwkDescriptionInterface

Overrides:

setTitleName in class FwkDescription

Parameters:

name - The name of the title.

See Also:

getName()

toString

public java.lang.String toString()

Get a string representation of the object.

Overrides:

toString in class FwkCommand

Returns:

The repesentation string.

getTransferDataFlavors

public java.awt.datatransfer.DataFlavor[] getTransferDataFlavors()

Returns an array of DataFlavor objects indicating the flavors the data can be provided in. The array should be ordered according to preference for providing the data (from most richly descriptive to least descriptive).

Specified by:

getTransferDataFlavors in interface java.awt.datatransfer.Transferable

Overrides:

getTransferDataFlavors in class FwkDescription

Returns:

an array of data flavors in which this data can be transferred

isDataFlavorSupported

public boolean isDataFlavorSupported(java.awt.datatransfer.DataFlavor flavor)

Returns whether or not the specified data flavor is supported for this object.

Specified by:

isDataFlavorSupported in interface java.awt.datatransfer.Transferable

Overrides:

isDataFlavorSupported in class FwkDescription

Parameters:

flavor - - the requested flavor for the data

Returns:

boolean indicating wjether or not the data flavor is supported

getTransferData

public java.lang.Object getTransferData(java.awt.datatransfer.DataFlavor flavor)
                                 throws java.awt.datatransfer.UnsupportedFlavorException,
                                        java.io.IOException

Returns an object which represents the data to be transferred. The class of the object returned is defined by the representation class of the flavor.

Specified by:

getTransferData in interface java.awt.datatransfer.Transferable

Overrides:

getTransferData in class FwkDescription

Parameters:

flavor - - the requested flavor for the data

Throws:

java.io.IOException - - if the data is no longer available in the requested flavor. UnsupportedFlavorException - if the requested data flavor is not supported.

java.awt.datatransfer.UnsupportedFlavorException

See Also:

java.awt.datatransfer.DataFlavor.getRepresentationClass()

lostOwnership

public void lostOwnership(java.awt.datatransfer.Clipboard clipboard,
                 java.awt.datatransfer.Transferable contents)

Notifies this object that it is no longer the owner of the contents of the clipboard.

Specified by:

lostOwnership in interface java.awt.datatransfer.ClipboardOwner

Overrides:

lostOwnership in class FwkDescription

Parameters:

clipboard - - the clipboard that is no longer owned

contents - - the contents which this owner had placed on the clipboard

setDefaultCommands

public void setDefaultCommands()

Set the default command for that container.

The property group getPropertyGroupName() is used to get all available commands from configuration. If an element is set to null text string, the routine doesn't try to instanciate and generates no error message.

Example if the method getPropertyGroupName return MED.DataManipulator:
MED.DataManipulator.Cut = com.highqsoft.med.MEDCut MED.DataManipulator.Scale = null

Specified by:

setDefaultCommands in interface CommandContainerInterface

getPropertyGroupName

public abstract java.lang.String getPropertyGroupName()

Get the property group name to find the commands.

Returns:

the group name.

destroyController

public boolean destroyController()

Description copied from interface: FwkControllerInterface

Destroy the controller.

Specified by:

destroyController in interface FwkControllerInterface

Returns:

true if the operation was successful.