com.highqsoft.fwk

Class FwkDescription

java.lang.Object

com.highqsoft.fwk.Fwk

com.highqsoft.fwk.FwkDescription

All Implemented Interfaces:

FwkDescriptionInterface, FwkInterface, FwkTransferableInterface, java.awt.datatransfer.ClipboardOwner, java.awt.datatransfer.Transferable, java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

FwkCompare, FwkDOMHandler, FwkDragAndDrop, FwkExecuteCommand, FwkPropertyChange, FwkThread, OdsxFilterValue, OdsxSessionFactory

public class FwkDescription
extends Fwk
implements java.lang.Cloneable, FwkDescriptionInterface

The default FwkDescriptionInterface implementation.

Since:

$Date: 2017/04/28 08:47:40 $

Version:

$Revision: 1.15 $

Author:

HighQSoft GmbH

See Also:

, Serialized Form

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.lang.String	className The class name of the FWK object.
protected java.lang.String	company The company name.
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.
static FwkIconInterface	FWK_ICON
static byte[]	FWK_ICON_ARRAY The default icon array.
static FwkIconInterface	FWK_ICON_BG
static byte[]	FWK_ICON_BG_ARRAY
static FwkIconInterface	FWK_ICON_BG_LARGE
static byte[]	FWK_ICON_BG_LARGE_ARRAY
static FwkIconInterface	FWK_ICON_LARGE
static byte[]	FWK_ICON_LARGE_ARRAY
protected FwkIconInterface[]	icon
static 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 java.lang.String	titleName
static java.lang.String	version

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
FwkDescription() The default constructor

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAuthor() Get the author name.
java.lang.String	getBuild() Get the build number.
java.lang.String	getClassName() Get the class name of the FWK object.
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.
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.
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.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.
void	setAuthor(java.lang.String author) Set the author name.
void	setBuild(java.lang.String buildnr) Set the build number.
void	setClassName(java.lang.String className) Set the class name of the FWK object.
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) 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	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.
java.lang.String	toString() Get a string representation of the object.

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

release

Field Detail

FWK_ICON_ARRAY

public static final byte[] FWK_ICON_ARRAY

The default icon array.

FWK_ICON_BG_ARRAY

public static final byte[] FWK_ICON_BG_ARRAY

FWK_ICON_LARGE_ARRAY

public static final byte[] FWK_ICON_LARGE_ARRAY

FWK_ICON_BG_LARGE_ARRAY

public static final byte[] FWK_ICON_BG_LARGE_ARRAY

FWK_ICON

public static final FwkIconInterface FWK_ICON

FWK_ICON_BG

public static final FwkIconInterface FWK_ICON_BG

FWK_ICON_LARGE

public static final FwkIconInterface FWK_ICON_LARGE

FWK_ICON_BG_LARGE

public static final FwkIconInterface FWK_ICON_BG_LARGE

ICON

public static final FwkIconInterface[] ICON

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.

className

protected java.lang.String className

The class name of the FWK object.

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

FwkDescription

public FwkDescription()

The default 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 Fwk

getAuthor

public java.lang.String getAuthor()

Get the author name.

Specified by:

getAuthor in interface FwkDescriptionInterface

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

Returns:

The string representing the build number.

See Also:

#setBuild(int)

getClassName

public java.lang.String getClassName()

Get the class name of the FWK object.

Specified by:

getClassName in interface FwkDescriptionInterface

Returns:

The class name.

See Also:

setClassName(String)

getCompany

public java.lang.String getCompany()

Get the company name.

Specified by:

getCompany in interface FwkDescriptionInterface

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

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

Returns:

The copyright string.

See Also:

setCopyright(String)

getCreationDate

public java.lang.String getCreationDate()

Get the creation date.

Specified by:

getCreationDate in interface FwkDescriptionInterface

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

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

Returns:

The date format string.

getDescription

public java.lang.String getDescription()

Get the description.

Specified by:

getDescription in interface FwkDescriptionInterface

Returns:

The description of the application.

See Also:

setDescription(String)

getIcon

public FwkIconInterface getIcon()

Get the icon image.

Specified by:

getIcon in interface FwkDescriptionInterface

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

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

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

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

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

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

Returns:

The presentation string.

getSupportEMail

public java.lang.String getSupportEMail()

Get the support e-mail.

Specified by:

getSupportEMail in interface FwkDescriptionInterface

Returns:

A string containing the support e-mail.

getTitle

public java.lang.String getTitle()

Get the title.

Specified by:

getTitle in interface FwkDescriptionInterface

Returns:

The title of the application.

getTitleName

public java.lang.String getTitleName()

Get the title name.

Specified by:

getTitleName in interface FwkDescriptionInterface

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

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

Parameters:

buildnr - The string representing the build number.

See Also:

getBuild()

setClassName

public void setClassName(java.lang.String className)

Set the class name of the FWK object.

Specified by:

setClassName in interface FwkDescriptionInterface

Parameters:

className - The class name.

See Also:

getClassName()

setCompany

public void setCompany(java.lang.String company)

Set the company name.

Specified by:

setCompany in interface FwkDescriptionInterface

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

setCopyright

public void setCopyright(java.lang.String copyright)

Set the copyright.

Specified by:

setCopyright in interface FwkDescriptionInterface

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

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

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

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

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

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 FwkDescriptionInterface

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

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 FwkDescriptionInterface

Parameters:

key - The keyword for the icon.

setIconKey

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

Set the property keyword of the icon.

Specified by:

setIconKey in interface FwkDescriptionInterface

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

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

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

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 java.lang.Object

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

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

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

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

Parameters:

clipboard - - the clipboard that is no longer owned

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