com.highqsoft.fwk

Class FwkPersistence

java.lang.Object

com.highqsoft.fwk.Fwk

com.highqsoft.fwk.FwkDescription

com.highqsoft.fwk.FwkPropertyChange

com.highqsoft.fwk.FwkPersistence

All Implemented Interfaces:

FwkCompareInterface, FwkControllerInterface, FwkDescriptionInterface, FwkInstructionInterface, FwkInterface, FwkPersistenceInterface, FwkPresentationInterface, FwkPropertyChangeInterface, FwkTransferableInterface, FwkVetoableChangeInterface, java.awt.datatransfer.ClipboardOwner, java.awt.datatransfer.Transferable, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable

Direct Known Subclasses:

FwkItem, OdsxFilteredTreeNode

public class FwkPersistence
extends FwkPropertyChange
implements FwkPersistenceInterface

The FwkPersistence class implements the FwkPersistanceInterface.

Since:

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

Version:

$Revision: 1.14 $

Author:

Andreas Hofmann

See Also:

, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	version

Fields inherited from class com.highqsoft.fwk.FwkPropertyChange

source

Fields inherited from class com.highqsoft.fwk.FwkDescription

author, buildnr, className, company, copyright, creationDate, dateFormatString, description, eMail, 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, ICON, iconCount, iconKey, internetAddress, name, titleName

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
FwkPersistence() The constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addCommand(FwkCommandInterface command) Add the command to the command array.
void	addCommand(int index, FwkCommandInterface command) Insert a command at the specified position.
void	addToGroup(int index, java.lang.String groupIdent, java.lang.String commandName) Add a command to a group.
void	addToGroup(java.lang.String groupIdent, java.lang.String commandName) Add a command to a group.
void	addVetoableChangeListener(FwkVetoableChangeListenerInterface listener) Add a VetoableChangeListener to the listener list.
void	addVetoableChangeListener(java.lang.String propertyName, FwkVetoableChangeListenerInterface listener) Add a VetoableChangeListener for a specific property.
void	clearCommands() Clear all commands.
boolean	commandsAvailable() This method returns a boolean that indicates whether the command array is initialized.
int	compareTo(java.lang.Object o) Compare the component to another.
void	deleteGroup(java.lang.String groupIdent) Delete command group.
boolean	destroyController() Destroy method.
protected void	fireVetoableChange(java.beans.PropertyChangeEvent evt) Fire an existing VetoableChangeEvent to any registered listeners.
protected void	fireVetoableChange(java.lang.String propertyName, boolean oldValue, boolean newValue) Report a boolean bound vetoable update to any registered listeners.
protected void	fireVetoableChange(java.lang.String propertyName, char oldValue, char newValue) Report an char bound vetoable update to any registered listeners.
protected void	fireVetoableChange(java.lang.String propertyName, double oldValue, double newValue) Report an double bound property update to any registered listeners.
protected void	fireVetoableChange(java.lang.String propertyName, float oldValue, float newValue) Report an float bound vetoable update to any registered listeners.
protected void	fireVetoableChange(java.lang.String propertyName, int oldValue, int newValue) Report an int bound property update to any registered listeners.
protected void	fireVetoableChange(java.lang.String propertyName, long oldValue, long newValue) Report an long bound vetoable update to any registered listeners.
void	fireVetoableChange(java.lang.String propertyName, java.lang.Object oldValue, java.lang.Object newValue) Report a bound property update to any registered listeners.
java.lang.String	getAuthor() Get the author name.
java.lang.String	getBuild() Get the build number.
FwkCommandInterface	getCommand(java.lang.String commandName) Return the command that matches the given command name.
FwkCommandInterface[]	getCommands() Retrieve the command array of the command.
FwkCommandInterface[]	getCommands(FwkControllerInterface controller) Retrieve the command array of the component.
java.lang.String	getCompany() Get the company name.
java.lang.String	getCompanyInternetAddress() Get the internet address of the company.
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.
FwkArrayInterface	getFwkMimeTypes() Return the mimetypes of the component.
FwkCommandInterface[]	getGroup(java.lang.String groupIdent) Retrieve the command group.
FwkIconInterface	getIcon() Get the icon of the application.
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() Get the name.
void	getPersistentObjectNames(FwkPersistenceInfoInterface persistentObjects) Get the names of the persistent objects from a component.
java.lang.String	getSupportEMail() Get the support e-mail.
java.lang.String	getTitle() Get the title.
java.lang.String	getTitleName() Get the title name.
java.lang.String	getVersion() Return the version string of the FWK component.
FwkArrayInterface	getVetoableChangeArray() Get an array containing the property names for that listeners are registered.
FwkArrayInterface	getVetoableChangeListenerArray() Get an array containing the registered vetoable change listeners.
FwkArrayInterface	getVetoableChangeListenerArray(java.lang.String propertyName) Get an array containing the registered vetoable change listeners for the specific vetoable.
boolean	groupExists(java.lang.String groupIdent) Check whether a group exists.
void	removeCommand(FwkCommandInterface command) Remove a sub-command.
void	removeFromGroup(java.lang.String groupIdent, java.lang.String commandName) Remove a command from a group.
void	removeVetoableChangeListener(FwkVetoableChangeListenerInterface listener) Remove a VetoableChangeListener from the listener list.
void	removeVetoableChangeListener(java.lang.String propertyName, FwkVetoableChangeListenerInterface listener) Remove a VetoableChangeListener for a specific property.
void	setAuthor(java.lang.String author) Set the author name.
void	setBuild(java.lang.String buildnr) Set the build number.
void	setCommands(FwkCommandInterface[] commands) Set the sub-commands of the command.
void	setCompany(java.lang.String company) Set the company name.
void	setCompanyInternetAddress(java.lang.String address) Set the internet address of the company.
void	setCopyright(java.lang.String copyright) Set the copyright.
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	setDescription(java.lang.String description) Set the description of the application.
void	setDescriptor(FwkCompareInterface descriptor) Initialize the object with values of the given descriptor.
void	setDescriptor(FwkDescriptionInterface descriptor) Initialize the object with values of the given FwkDescription.
void	setIcon(FwkIconInterface icon) Get the icon of the application.
void	setIcon(FwkIconInterface icon, int type) Set the image icon of the application This method fires a property change event on property "Icon".
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 application name.
void	setSource(FwkInterface source) Set the bean source object of the veto change support.
void	setSupportEMail(java.lang.String eMail) Get the support e-mail.
void	setTitleName(java.lang.String name) Set the application title name.

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, suspendPropertyChangeEvents

Methods inherited from class com.highqsoft.fwk.FwkDescription

getClassName, getPresentationString, getPresentationString, getTransferData, getTransferDataFlavors, isDataFlavorSupported, lostOwnership, setClassName, setCreationDate, toString

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

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

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

getClassName, getPresentationString, getPresentationString, setClassName, setCreationDate

Methods inherited from interface java.awt.datatransfer.Transferable

getTransferData, getTransferDataFlavors, isDataFlavorSupported

Methods inherited from interface java.awt.datatransfer.ClipboardOwner

lostOwnership

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

getPresentationString, getPresentationString

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

release

Field Detail

version

public static final java.lang.String version

See Also:

Constant Field Values

Constructor Detail

FwkPersistence

public FwkPersistence()

The constructor.

Parameters:

itemName - The name of the infobus data item.

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 FwkPropertyChange

getPersistentObjectNames

public void getPersistentObjectNames(FwkPersistenceInfoInterface persistentObjects)

Get the names of the persistent objects from a component. The parameter is a list of objects. The component must extend this list. The component must not clear the list.
This method is only a plain implementation and does nothing.

Specified by:

getPersistentObjectNames in interface FwkPersistenceInterface

Parameters:

persistentObjects - The names of persistent objects.

setSource

public void setSource(FwkInterface source)

Set the bean source object of the veto change support.

Specified by:

setSource in interface FwkPropertyChangeInterface

Overrides:

setSource in class FwkPropertyChange

Parameters:

source - The component to be given as the source for any events.

getVetoableChangeListenerArray

public FwkArrayInterface getVetoableChangeListenerArray()

Get an array containing the registered vetoable change listeners.

Specified by:

getVetoableChangeListenerArray in interface FwkVetoableChangeInterface

Returns:

The requested vector.

getVetoableChangeListenerArray

public FwkArrayInterface getVetoableChangeListenerArray(java.lang.String propertyName)

Get an array containing the registered vetoable change listeners for the specific vetoable.

Specified by:

getVetoableChangeListenerArray in interface FwkVetoableChangeInterface

Returns:

The requested vector.

getVetoableChangeArray

public FwkArrayInterface getVetoableChangeArray()

Get an array containing the property names for that listeners are registered.

Specified by:

getVetoableChangeArray in interface FwkVetoableChangeInterface

Returns:

The requested vector.

addVetoableChangeListener

public void addVetoableChangeListener(FwkVetoableChangeListenerInterface listener)

Add a VetoableChangeListener to the listener list.

Specified by:

addVetoableChangeListener in interface FwkVetoableChangeInterface

Parameters:

listener - The property change listener.

See Also:

VetoableChangeSupport

addVetoableChangeListener

public void addVetoableChangeListener(java.lang.String propertyName,
                             FwkVetoableChangeListenerInterface listener)

Add a VetoableChangeListener for a specific property.

Specified by:

addVetoableChangeListener in interface FwkVetoableChangeInterface

Parameters:

propertyName - The property name.

listener - The vetoable change listener.

See Also:

VetoableChangeSupport

fireVetoableChange

protected void fireVetoableChange(java.beans.PropertyChangeEvent evt)

Fire an existing VetoableChangeEvent to any registered listeners.

Parameters:

evt - The vetoable change event.

See Also:

VetoableChangeSupport

fireVetoableChange

protected void fireVetoableChange(java.lang.String propertyName,
                      boolean oldValue,
                      boolean newValue)

Report a boolean bound vetoable update to any registered listeners.

Parameters:

vetoableName - The vetoable name.

oldValue - The old value of the vetoable.

newValue - The new value of the vetoable.

See Also:

VetoableChangeSupport

fireVetoableChange

protected void fireVetoableChange(java.lang.String propertyName,
                      char oldValue,
                      char newValue)

Report an char bound vetoable update to any registered listeners.

Parameters:

propertyName - The property name.

oldValue - The old value of the property.

newValue - The new value of the property.

fireVetoableChange

protected void fireVetoableChange(java.lang.String propertyName,
                      int oldValue,
                      int newValue)

Report an int bound property update to any registered listeners.

Parameters:

propertyName - The property name.

oldValue - The old value of the property.

newValue - The new value of the property.

See Also:

VetoableChangeSupport

fireVetoableChange

protected void fireVetoableChange(java.lang.String propertyName,
                      long oldValue,
                      long newValue)

Report an long bound vetoable update to any registered listeners.

Parameters:

propertyName - The property name.

oldValue - The old value of the property.

newValue - The new value of the property.

fireVetoableChange

protected void fireVetoableChange(java.lang.String propertyName,
                      float oldValue,
                      float newValue)

Report an float bound vetoable update to any registered listeners.

Parameters:

propertyName - The property name.

oldValue - The old value of the property.

newValue - The new value of the property.

fireVetoableChange

protected void fireVetoableChange(java.lang.String propertyName,
                      double oldValue,
                      double newValue)

Report an double bound property update to any registered listeners.

Parameters:

propertyName - The property name.

oldValue - The old value of the property.

newValue - The new value of the property.

fireVetoableChange

public void fireVetoableChange(java.lang.String propertyName,
                      java.lang.Object oldValue,
                      java.lang.Object newValue)

Report a bound property update to any registered listeners.

Parameters:

propertyName - The property name.

oldValue - The old value of the property.

newValue - The new value of the property.

See Also:

VetoableChangeSupport

removeVetoableChangeListener

public void removeVetoableChangeListener(FwkVetoableChangeListenerInterface listener)

Remove a VetoableChangeListener from the listener list.

Specified by:

removeVetoableChangeListener in interface FwkVetoableChangeInterface

Parameters:

listener - The property change listener.

See Also:

VetoableChangeSupport

removeVetoableChangeListener

public void removeVetoableChangeListener(java.lang.String propertyName,
                                FwkVetoableChangeListenerInterface listener)

Remove a VetoableChangeListener for a specific property.

Specified by:

removeVetoableChangeListener in interface FwkVetoableChangeInterface

Parameters:

propertyName - The property name.

listener - The property change listener.

See Also:

VetoableChangeSupport

compareTo

public int compareTo(java.lang.Object o)

Compare the component to another.

Specified by:

compareTo in interface java.lang.Comparable

Parameters:

object - The object to compare to.

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 number of build.

See Also:

#setBuild(int)

getCompany

public java.lang.String getCompany()

Get the company name.

Specified by:

getCompany in interface FwkDescriptionInterface

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 of the application.

Specified by:

getIcon in interface FwkDescriptionInterface

Overrides:

getIcon in class FwkDescription

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 FwkDescriptionInterface

Overrides:

getIconKey in class FwkDescription

Returns:

The keyword for the icon.

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()

Get the name.

Specified by:

getName in interface FwkDescriptionInterface

Overrides:

getName in class FwkDescription

Returns:

The name of the application.

See Also:

setName(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.

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:

setTitleName(String)

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.

setAuthor

public void setAuthor(java.lang.String author)

Set the author name. This method fires a property change event on property "Author".

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. This method fires a property change event on property "Build".

Specified by:

setBuild in interface FwkDescriptionInterface

Overrides:

setBuild in class FwkDescription

Parameters:

The - number of build.

See Also:

getBuild()

setCompany

public void setCompany(java.lang.String company)

Set the company name. This method fires a property change event on property "Company".

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. This method fires a property change event on property "CompanyInternetAddress".

Specified by:

setCompanyInternetAddress in interface FwkDescriptionInterface

Overrides:

setCompanyInternetAddress in class FwkDescription

setCreationDate

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

Set the Date of the application. This method fires a property change event on property "CreationDate".

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()

setDateFormatString

public void setDateFormatString(java.lang.String formatString)

Set the Date format string. This method fires a property change event on property "DateFormatString".

Specified by:

setDateFormatString in interface FwkDescriptionInterface

Overrides:

setDateFormatString in class FwkDescription

Parameters:

formatString - The format string.

See Also:

#java.text.SimpleDateFormat, getCreationDate()

setDescriptor

public void setDescriptor(FwkDescriptionInterface descriptor)

Initialize the object with values of the given FwkDescription.

Specified by:

setDescriptor in interface FwkDescriptionInterface

Overrides:

setDescriptor in class FwkDescription

Parameters:

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

setCopyright

public void setCopyright(java.lang.String copyright)

Set the copyright. This method fires a property change event on property "Copyright".

Specified by:

setCopyright in interface FwkDescriptionInterface

Overrides:

setCopyright in class FwkDescription

Parameters:

The - copyright string.

See Also:

getCopyright()

setDescription

public void setDescription(java.lang.String description)

Set the description of the application. This method fires a property change event on property "Description".

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(FwkCompareInterface descriptor)

Initialize the object with values of the given descriptor.

Parameters:

desciptor - The FwkCompare from that the value should be copied.

setIcon

public void setIcon(FwkIconInterface icon)

Get the icon of the application. This method fires a property change event on property "Icon".

Specified by:

setIcon in interface FwkDescriptionInterface

Overrides:

setIcon in class FwkDescription

See Also:

#getIcon(FwkIconInterface)

setIcon

public void setIcon(FwkIconInterface icon,
           int type)

Set the image icon of the application This method fires a property change event on property "Icon".

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.

See Also:

getIcon()

setIconKey

public void setIconKey(java.lang.String key)

Set the property keyword of the icon. This method fires a property and vetoable change event on property "IconKey".

Specified by:

setIconKey in interface FwkDescriptionInterface

Overrides:

setIconKey in class FwkDescription

Parameters:

key - The keyword for the icon.

setIconKey

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

Set the property keyword of the icon. This method fires a property and vetoable change event on property "IconKey".

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 application name. This method fires a property and vetoable change event on property "Name".

Specified by:

setName in interface FwkDescriptionInterface

Overrides:

setName in class FwkDescription

Parameters:

name - The name of the application.

See Also:

getName()

setSupportEMail

public void setSupportEMail(java.lang.String eMail)

Get the support e-mail. This method fires a property and vetoable change event on property "SupportEMail".

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 name)

Set the application title name. This method fires a property and vetoable change event on property "TitleName".

Specified by:

setTitleName in interface FwkDescriptionInterface

Overrides:

setTitleName in class FwkDescription

Parameters:

name - The title name of the application.

See Also:

getTitleName()

getFwkMimeTypes

public FwkArrayInterface getFwkMimeTypes()

Return the mimetypes of the component.

addCommand

public void addCommand(FwkCommandInterface command)

Add the command to the command array. This method fires a property and vetoable change event on the property Command. The new value object of the event is the incoming command the old value object is this.

Specified by:

addCommand in interface FwkInstructionInterface

Parameters:

command - The command to be added.

addCommand

public void addCommand(int index,
              FwkCommandInterface command)

Insert a command at the specified position. If the position is out of range. The method inserts the command at the beginning or appand it to existing array.

Specified by:

addCommand in interface FwkInstructionInterface

Parameters:

index - The position where the command has to be inserted.

command - The command to be added.

getCommand

public FwkCommandInterface getCommand(java.lang.String commandName)

Return the command that matches the given command name.

Specified by:

getCommand in interface FwkInstructionInterface

Parameters:

commandName - The name of the requested command.

Returns:

The command or null if no matching command found.

getCommands

public FwkCommandInterface[] getCommands(FwkControllerInterface controller)

Retrieve the command array of the component. If there are no commands available the method initialize the commands and use the given object as controller. The command "Help" will be added by default.

Specified by:

getCommands in interface FwkPersistenceInterface

Parameters:

controller - The Command controller.

Returns:

The array containing the commands.

getCommands

public FwkCommandInterface[] getCommands()

Retrieve the command array of the command.

Specified by:

getCommands in interface FwkInstructionInterface

Returns:

The array containing the commands.

commandsAvailable

public boolean commandsAvailable()

This method returns a boolean that indicates whether the command array is initialized.

Specified by:

commandsAvailable in interface FwkInstructionInterface

Returns:

true if the command array is already initialized.

clearCommands

public void clearCommands()

Clear all commands.

Specified by:

clearCommands in interface FwkInstructionInterface

removeCommand

public void removeCommand(FwkCommandInterface command)

Remove a sub-command. This method fires a property and vetoable change event on the property RemoveCommand. The new value object of the event is this the old value object is the removed sub-command.

Specified by:

removeCommand in interface FwkInstructionInterface

Parameters:

command - The sub-command to be removed.

setCommands

public void setCommands(FwkCommandInterface[] commands)

Set the sub-commands of the command. All existing sub-commands will be removed. This method fires a property and vetoable change event on the property Command. The new value object of the event is the incoming array the old value object is this.

Specified by:

setCommands in interface FwkInstructionInterface

Parameters:

commands - The array containing the sub-commands.

See Also:

FwkInstructionInterface.addCommand(FwkCommandInterface command)

addToGroup

public void addToGroup(int index,
              java.lang.String groupIdent,
              java.lang.String commandName)

Add a command to a group.

Specified by:

addToGroup in interface FwkInstructionInterface

Parameters:

index - Index where the command should be placed.

groupIdent - The string identified of the group.

commandName - The name of the command.

addToGroup

public void addToGroup(java.lang.String groupIdent,
              java.lang.String commandName)

Add a command to a group.

Specified by:

addToGroup in interface FwkInstructionInterface

Parameters:

groupIdent - The string identified of the group.

commandName - The name of the command.

removeFromGroup

public void removeFromGroup(java.lang.String groupIdent,
                   java.lang.String commandName)

Remove a command from a group.

Specified by:

removeFromGroup in interface FwkInstructionInterface

Parameters:

groupIdent - The string identified of the group.

commandName - The name of the command.

deleteGroup

public void deleteGroup(java.lang.String groupIdent)

Delete command group.

Specified by:

deleteGroup in interface FwkInstructionInterface

Parameters:

groupIdent - The string identified of the group.

getGroup

public FwkCommandInterface[] getGroup(java.lang.String groupIdent)

Retrieve the command group.

Specified by:

getGroup in interface FwkInstructionInterface

Parameters:

groupIdent - The string identified of the group.

Returns:

A component array containing the group commands or null if empty.

groupExists

public boolean groupExists(java.lang.String groupIdent)

Check whether a group exists.

Specified by:

groupExists in interface FwkInstructionInterface

Returns:

true if the group exists.

destroyController

public boolean destroyController()

Destroy method. Does nothing here.

Specified by:

destroyController in interface FwkControllerInterface

Returns:

true if the operation was successful.