com.highqsoft.interfaces.odsx

Interface OdsxPresentableElementInterface

All Superinterfaces:

javax.infobus.ArrayAccess, java.awt.datatransfer.ClipboardOwner, java.lang.Comparable, javax.infobus.DataItem, javax.infobus.DataItemChangeManager, FwkCompareInterface, FwkDescriptionInterface, FwkInfoBusDataAccessInterface, FwkInfoBusImmediateAccessInterface, FwkInfoBusItemGroupInterface, FwkInstructionInterface, FwkInterface, FwkPresentationInterface, FwkPropertyChangeInterface, FwkTransferableInterface, javax.infobus.ImmediateAccess, java.io.Serializable, java.awt.datatransfer.Transferable

All Known Subinterfaces:

OdsxApplicationElementInterface, OdsxColumnInterface, OdsxInstanceElementInterface, OdsxSessionElementInterface

All Known Implementing Classes:

OdsxApplicationElement, OdsxColumn, OdsxInstanceElement, OdsxPresentableElement, OdsxRecursiveApplicationElement, OdsxSessionElement

public interface OdsxPresentableElementInterface
extends FwkInfoBusDataAccessInterface, FwkPropertyChangeInterface, FwkInstructionInterface

The OdsxPresentableElementInterface is the interface for presentable elements.

Since:

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

Version:

$Revision: 1.13 $

Author:

Andreas Hofmann

See Also:

Field Summary

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

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

Method Summary

Methods

Modifier and Type	Method and Description
void	delete(boolean flag) Delete the element.
java.lang.String	getBaseName() Get the base type identifier.
java.util.Vector<OdsxPresentableElementInterface>	getElements() Get the child elements of this element.
java.lang.String	getIdentificationString() Retrieves the identification string form the element.
java.lang.String	getODSVersion() Get the ODS version of the element
OdsxFilterInterface	getOdsxFilter() Retrieve the filter of this element.
java.lang.String	getPresentationString(java.util.Locale l, OdsxFilterInterface f) Retrieves the representation string.
void	getPresentationString(java.io.Writer w, java.lang.String spec, java.util.Locale l, OdsxFilterInterface f) Print out the presentation into a writer.
java.util.Vector<OdsxPresentableElementInterface>	getRelatedElements() Get the related elements of this element.
ApplicationRelation[]	getRelations() Get the relation type to the given element.
ApplicationRelation[]	getRelations(OdsxPresentableElementInterface elem) Get the relation type to the given element.
AoSession	getSession() Get the root object.
java.lang.String	getShortName() Retrieves a short name from element.
java.lang.String	getShortName(int length) Retrieves a short name from element.
java.lang.Object	getValueAsObject() Get the value as object.
boolean	isTheSame(OdsxPresentableElementInterface elem) Return a boolean whether the given element is the element as the incoming one.
boolean	isValid() Return a boolean wether the element is already valid.
boolean	matchBaseElement(java.lang.String baseElementName) Ask for base element instance.
void	setOdsxFilter(OdsxFilterInterface odsFilter) Set the filter of this element.
void	setValueAsObject(java.lang.Object value) Set the value of the item.
boolean	valueIsA(java.lang.Class<?> clazz) Return a boolean whether the value is a subclass of the given class.

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

getName, hasValidValues, isGroup, setProperty, setValidValues

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

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

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

getVersion, release

Methods inherited from interface java.awt.datatransfer.Transferable

getTransferData, getTransferDataFlavors, isDataFlavorSupported

Methods inherited from interface java.awt.datatransfer.ClipboardOwner

lostOwnership

Methods inherited from interface java.lang.Comparable

compareTo

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

addChild, addChildListener, containsChild, getAllChildren, getAllChildren, getChildren, getChildren, getChildrenCount, hasChildren, removeAllChildren, removeChild, removeChild, removeChildListener, setChildren

Methods inherited from interface javax.infobus.DataItem

getProperty, getSource, release

Methods inherited from interface javax.infobus.ImmediateAccess

getPresentationString, getValueAsString, setValue

Methods inherited from interface javax.infobus.DataItemChangeManager

addDataItemChangeListener, removeDataItemChangeListener

Methods inherited from interface javax.infobus.ArrayAccess

getDimensions, getItemByCoordinates, setItemByCoordinates, subdivide

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

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

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

getPresentationString, getPresentationString

Method Detail

getBaseName

java.lang.String getBaseName()

Get the base type identifier.

Returns:

The base type string.

isTheSame

boolean isTheSame(OdsxPresentableElementInterface elem)

Return a boolean whether the given element is the element as the incoming one.

Parameters:

elem - The element to be compared to

Returns:

true if this element is the same as the incoming.

setValueAsObject

void setValueAsObject(java.lang.Object value)
                      throws java.lang.RuntimeException

Set the value of the item.

Parameters:

value - the new value.

Throws:

java.lang.RuntimeException

getSession

AoSession getSession()
                     throws java.lang.RuntimeException

Get the root object.

Returns:

the session object.

Throws:

java.lang.RuntimeException

getValueAsObject

java.lang.Object getValueAsObject()

Get the value as object.

Specified by:

getValueAsObject in interface javax.infobus.ImmediateAccess

Returns:

The value object.

getElements

java.util.Vector<OdsxPresentableElementInterface> getElements()

Get the child elements of this element.

Returns:

an array containing the child elements, that are implement OdsxPresentableElementInterface. if there are no children the method returns null.

getRelatedElements

java.util.Vector<OdsxPresentableElementInterface> getRelatedElements()

Get the related elements of this element.

Returns:

an array containing the related elements, that are implement OdsxPresentableElementInterface if there are no elements the method returns null.

getRelations

ApplicationRelation[] getRelations()

Get the relation type to the given element.

Returns:

the relation type.

getRelations

ApplicationRelation[] getRelations(OdsxPresentableElementInterface elem)

Get the relation type to the given element.

Parameters:

elem - The element to that the relation should be determined.

Returns:

the relation type.

getShortName

java.lang.String getShortName()

Retrieves a short name from element.

Returns:

The short name of the element.

getShortName

java.lang.String getShortName(int length)

Retrieves a short name from element.

Parameters:

length - the maximum length of the name.

Returns:

The short name of the element.

getIdentificationString

java.lang.String getIdentificationString()

Retrieves the identification string form the element.

Returns:

The identification the element.

getPresentationString

java.lang.String getPresentationString(java.util.Locale l,
                                     OdsxFilterInterface f)

Retrieves the representation string. Currently it returns the name.

Parameters:

l - The Locale object or null.

f - An ODSFilterInterface object.

Returns:

The presentation string.

getPresentationString

void getPresentationString(java.io.Writer w,
                         java.lang.String spec,
                         java.util.Locale l,
                         OdsxFilterInterface f)
                           throws java.io.IOException

Print out the presentation into a writer.

Parameters:

w - The writer.

spec - This string allows the caller to specify the kind of output.

l - The Locale object or null.

f - An ODSFilterInterface object.

Throws:

java.io.IOException

setOdsxFilter

void setOdsxFilter(OdsxFilterInterface odsFilter)

Set the filter of this element.

Parameters:

odsFilter - the filter.

getOdsxFilter

OdsxFilterInterface getOdsxFilter()

Retrieve the filter of this element.

Returns:

the filter.

delete

void delete(boolean flag)

Delete the element.

Parameters:

flag - true if the element should be deleted with references.

matchBaseElement

boolean matchBaseElement(java.lang.String baseElementName)

Ask for base element instance.

Returns:

true if the element is an instance of the base element with the given name.

valueIsA

boolean valueIsA(java.lang.Class<?> clazz)

Return a boolean whether the value is a subclass of the given class.

Parameters:

clazz - The class to be implemented by the value.

getODSVersion

java.lang.String getODSVersion()

Get the ODS version of the element

Returns:

the ods version of the element.

isValid

boolean isValid()

Return a boolean wether the element is already valid.

Returns:

true if valid