public interface FwkDescriptionInterface extends FwkInterface, FwkTransferableInterface
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
AUTHOR
The default author text string.
|
static java.lang.String |
BUILDNR
The default build number.
|
static java.lang.String |
COMPANY
The default company name.
|
static java.lang.String |
COPYRIGHT
The default copyright string.
|
static java.lang.String |
DATE_FORMAT
The default data format string.
|
static int |
DEFAULT_ICON
The type value for the default icon.
|
static java.lang.String |
DESCRIPTION
The default description.
|
static java.lang.String |
INTERNET
The default company internet address.
|
static int |
LARGE_ICON
The type value for the opaque default icon.
|
static java.lang.String |
LARGE_KEY_EXT
The key extention for the large icon.
|
static int |
LARGE_OPAQUE_ICON
The type value for the large opaque icon.
|
static java.lang.String |
LARGE_OPAQUE_KEY_EXT
The key extention for the large opaque icon.
|
static int |
OPAQUE_ICON
The type value for the opaque default icon.
|
static java.lang.String |
OPAQUE_KEY_EXT
The key extention for the opaque icon.
|
static java.lang.String |
RCS_DATE_FORMAT
The RCS data format string.
|
static java.lang.String |
SUPPORT_EMAIL
The default support e-mail.
|
static java.lang.String |
TITLE_NAME
The default title string.
|
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 image 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()
Return the name of the 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.
|
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 image icon of the application
|
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 name of the application.
|
getVersion, release
static final int DEFAULT_ICON
static final int OPAQUE_ICON
static final int LARGE_ICON
static final int LARGE_OPAQUE_ICON
static final java.lang.String OPAQUE_KEY_EXT
static final java.lang.String LARGE_KEY_EXT
static final java.lang.String LARGE_OPAQUE_KEY_EXT
static final java.lang.String AUTHOR
static final java.lang.String BUILDNR
static final java.lang.String COMPANY
static final java.lang.String COPYRIGHT
static final java.lang.String DATE_FORMAT
#java.text.SimpleDataFormat
,
Constant Field Valuesstatic final java.lang.String DESCRIPTION
static final java.lang.String INTERNET
static final java.lang.String RCS_DATE_FORMAT
#java.text.SimpleDataFormat
,
Constant Field Valuesstatic final java.lang.String SUPPORT_EMAIL
static final java.lang.String TITLE_NAME
java.lang.String getAuthor()
setAuthor(String)
java.lang.String getBuild()
#setBuild(int)
java.lang.String getClassName()
setClassName(String)
java.lang.String getCompany()
setCompany(String)
java.lang.String getCompanyInternetAddress()
java.lang.String getCopyright()
setCopyright(String)
java.lang.String getCreationDate()
#setCreationDate(Date)
java.lang.String getCreationDate(java.lang.String formatString)
formatString
- The date format string#java.text.SimpleDateFormat
,
#setCreationDate(Date)
java.lang.String getDateFormatString()
java.lang.String getDescription()
setDescription(String)
FwkIconInterface getIcon()
#setIcon(Icon)
FwkIconInterface getIcon(int type)
type
- The type of the icon, use the predefined values (see above).#setIcon(Icon)
java.lang.String getIconKey()
java.lang.String getIconKey(int type)
type
- The type of the icon, use the predefined values (see above).java.lang.String getName()
java.lang.String getPresentationString(java.util.Locale locale)
locale
- The Locale object or null.java.lang.String getPresentationString()
java.lang.String getSupportEMail()
java.lang.String getTitle()
java.lang.String getTitleName()
setTitleName(String)
void setAuthor(java.lang.String author)
author
- The name of the author.getAuthor()
void setBuild(java.lang.String buildnr)
The
- string of the build number.getBuild()
void setClassName(java.lang.String className)
className
- The class name.getClassName()
void setCompany(java.lang.String company)
company
- The name of the company.getCompany()
void setCompanyInternetAddress(java.lang.String address)
void setCopyright(java.lang.String copyright)
The
- copyright string.getCopyright()
void setCreationDate(java.lang.String dateString, java.lang.String formatString)
dateString
- The Date of the application.formatString
- The format string.#java.text.SimpleDateFormat
,
getCreationDate()
void setCreationDate(java.lang.String dateString)
dateString
- The Date of the application.#java.text.SimpleDateFormat
,
getCreationDate()
void setDateFormatString(java.lang.String formatString)
formatString
- The format string.#java.text.SimpleDateFormat
,
getCreationDate()
void setDescription(java.lang.String description)
description
- The description of the application.getDescription()
void setDescriptor(FwkDescriptionInterface descriptor) throws java.lang.RuntimeException
desciptor
- The FwkDescription from that the value should be copied.java.lang.RuntimeException
void setIcon(FwkIconInterface Icon)
getIcon()
void setIcon(FwkIconInterface icon, int type)
icon
- The icon to be set.type
- The type of the icon, use predefined values defined above.getIcon()
void setIconKey(java.lang.String key)
key
- The keyword for the icon.void setIconKey(java.lang.String key, int type)
key
- The keyword for the icon.type
- The type of the icon, use predefined values defined above.void setName(java.lang.String name)
name
- The name of the object.getName()
void setSupportEMail(java.lang.String eMail)
eMail
- A string containing the support e-mail.void setTitleName(java.lang.String titlename)
getTitleName()