public class OdsxSessionElement extends OdsxPresentableElement implements OdsxSessionElementInterface
| Interface | Description |
|---|---|
| OdsxSessionMenuInterface | Classes that implements that interface controls the whole menu of the session element. |
| OdsxSessionCustomizerInterface | Classes that implements that interface will be integrated as an part of the existing menu. |
FwkColumnAccess.FwkSubColumnAccessFwkInfoBusImmediateAccess.ElementConsumer| Modifier and Type | Field and Description |
|---|---|
protected static FwkDescriptionInterface |
descriptor |
static java.lang.String |
version |
beQueries, color, DEFAULT_COLOR, defaultObject, odsFilter, SEPARATOR, valueaverage, averageIsValid, columnName, CONSIDER_FLAGS, DESCRIPTION_COLUMN_NAME, icon, lower, minPositiveValue, observer, producer, range_lock, rangeIsValid, shortName, standardDeviation, standardDeviationIsValid, unit, upperchildren, properties, validchangeManager, suspendChangeManagersourceauthor, 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, iconCount, iconKey, internetAddress, name, titleNameAUTHOR, 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_NAMEDATAARRAY_KEY, DEFINED_BIT, INVALID, NOT_MODIFIED_BIT, VALID, VALID_BIT, VISIBLE_BITINFOBUS_SOURCE| Modifier | Constructor and Description |
|---|---|
protected |
OdsxSessionElement()
The constructor.
|
|
OdsxSessionElement(AoSession session)
The constructor receiving the session element.
|
| Modifier and Type | Method and Description |
|---|---|
java.lang.String |
getBaseName()
Get the base type identifier.
|
FwkCommandInterface[] |
getCommands()
Retrieve the command array.
|
static FwkDescriptionInterface |
getDescriptor() |
java.util.Vector |
getElements()
Get the children of this element.
|
java.lang.String |
getIdentificationString()
Get the identification string of the element.
|
void |
getPresentationString(java.io.Writer w,
java.lang.String spec,
java.util.Locale locale,
OdsxFilterInterface filter)
Print out the presentation into a writer.
|
AoSession |
getSession()
Get the session.
|
java.lang.String |
getVersion()
Return the version string of the FWK component.
|
boolean |
isTheSame(AoSession aoSession)
Return a boolean whether the given AoSession is equal to this one.
|
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.
|
void |
setItemByCoordinates(int[] coord,
java.lang.Object item)
Set a new value at the specified coordinate.
|
void |
setValueAsObject(java.lang.Object item)
Set the value of the item.
|
void |
writeEnumerations(java.io.Writer w,
java.lang.String spec,
java.util.Locale locale)
Write the enumeration definitions to the write stream.
|
delete, finalize, getDimensions, getIcon, getItemByCoordinates, getODSVersion, getOdsxFilter, getPresentationString, getPresentationString, getPresentationString, getRelatedElements, getRelations, getRelations, getShortName, getValueAsObject, getValueAsString, matchBaseElement, odsChanged, release, setOdsxFilter, subdivide, toString, valueIsAcreateEmptyColumn, dependsOn, determineRange, getAverage, getAverageFlag, getColumnName, getCommands, getCount, getFlagAt, getFlags, getIndex, getIndexRange, getMaximum, getMinimum, getMinPositiveValue, getNativeDatatype, getNativeValues, getNativeValues, getProperty, getScale, getShortName, getStandardDeviation, getStandardDeviationFlag, getTransferData, getTransferDataFlavors, getUnitString, getValueAt, getValues, independentColumns, isDataFlavorSupported, isImplicit, isIndependent, main, reshape, setColumnName, setFlagAt, setFlags, setIndependent, setItemByCoordinates, setItemByCoordinates, setItemByCoordinates, setItemByCoordinates, setItemByCoordinates, setItemByCoordinates, setName, setScale, setValue, setValueAtaddChild, addChildListener, containsChild, fireChildAdded, fireChildRemoved, getAllChildren, getAllChildren, getChildren, getChildren, getChildrenCount, hasChildren, hasValidValues, isGroup, removeAllChildren, removeChild, removeChild, removeChildListener, setChildren, setProperty, setValidValuesaddDataItemChangeListener, fireItemAdded, fireItemDeleted, fireItemRevoked, fireItemValueChanged, getName, getPropertyGroup, getSource, isChangeManagerSuspended, removeDataItemChangeListener, setPropertyGroup, suspendChangeManageraddCommand, addCommand, addToGroup, addToGroup, addVetoableChangeListener, addVetoableChangeListener, clearCommands, commandsAvailable, compareTo, deleteGroup, destroyController, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, getAuthor, getBuild, getCommand, getCompany, getCompanyInternetAddress, getCopyright, getCreationDate, getCreationDate, getDateFormatString, getDescription, getFwkMimeTypes, getGroup, getIcon, getIconKey, getIconKey, getPersistentObjectNames, getSupportEMail, getTitle, getTitleName, getVetoableChangeArray, getVetoableChangeListenerArray, getVetoableChangeListenerArray, groupExists, removeCommand, removeFromGroup, removeVetoableChangeListener, removeVetoableChangeListener, setAuthor, setBuild, setCommands, setCompany, setCompanyInternetAddress, setCopyright, setCreationDate, setDateFormatString, setDescription, setDescriptor, setDescriptor, setIcon, setIcon, setIconKey, setIconKey, setSource, setSupportEMail, setTitleNameaddPropertyChangeListener, addPropertyChangeListener, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getPropertyChangeArray, getPropertyChangeListenerArray, getPropertyChangeListenerArray, isPropertyChangeEventSuspended, removePropertyChangeListener, removePropertyChangeListener, suspendPropertyChangeEventsgetClassName, getPresentationString, lostOwnership, setClassName, setCreationDategetNiceVersionclone, equals, getClass, hashCode, notify, notifyAll, wait, wait, waitdelete, getODSVersion, getOdsxFilter, getPresentationString, getRelatedElements, getRelations, getRelations, getShortName, getShortName, getValueAsObject, matchBaseElement, setOdsxFilter, valueIsAgetName, hasValidValues, isGroup, setProperty, setValidValuesgetAuthor, 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, setTitleNamereleasegetTransferData, getTransferDataFlavors, isDataFlavorSupportedaddChild, addChildListener, containsChild, getAllChildren, getAllChildren, getChildren, getChildren, getChildrenCount, hasChildren, removeAllChildren, removeChild, removeChild, removeChildListener, setChildrengetPresentationString, getValueAsString, setValueaddDataItemChangeListener, removeDataItemChangeListenergetDimensions, getItemByCoordinates, subdivideaddPropertyChangeListener, addPropertyChangeListener, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getPropertyChangeArray, getPropertyChangeListenerArray, getPropertyChangeListenerArray, isPropertyChangeEventSuspended, removePropertyChangeListener, removePropertyChangeListener, setSource, suspendPropertyChangeEventsaddCommand, addCommand, addToGroup, addToGroup, clearCommands, commandsAvailable, deleteGroup, getCommand, getGroup, groupExists, removeCommand, removeFromGroup, setCommandsgetPresentationString, getPresentationStringisChangeManagerSuspended, suspendChangeManagergetPersistentObjectNamesdestroyControlleraddVetoableChangeListener, addVetoableChangeListener, getVetoableChangeArray, getVetoableChangeListenerArray, getVetoableChangeListenerArray, removeVetoableChangeListener, removeVetoableChangeListenerpublic static final java.lang.String version
protected static final FwkDescriptionInterface descriptor
protected OdsxSessionElement()
public OdsxSessionElement(AoSession session)
session - The ASAM-ODS session.public java.lang.String getVersion()
FwkInterfacegetVersion in interface FwkInterfacegetVersion in class OdsxPresentableElementpublic static FwkDescriptionInterface getDescriptor()
public boolean isValid()
isValid in interface OdsxPresentableElementInterfacepublic boolean isTheSame(AoSession aoSession)
isTheSame in interface OdsxSessionElementInterfaceaoSession - theAoSessionpublic boolean isTheSame(OdsxPresentableElementInterface elem)
isTheSame in interface OdsxPresentableElementInterfaceisTheSame in class OdsxPresentableElementelem - The element to be compared topublic java.lang.String getBaseName()
getBaseName in interface OdsxPresentableElementInterfacegetBaseName in class OdsxPresentableElementpublic AoSession getSession()
getSession in interface OdsxPresentableElementInterfacegetSession in interface OdsxSessionElementInterfacegetSession in class OdsxPresentableElementpublic void setItemByCoordinates(int[] coord,
java.lang.Object item)
throws FwkException
setItemByCoordinates in interface javax.infobus.ArrayAccesssetItemByCoordinates in class OdsxPresentableElementcoord - The coordinates where the new value should be placed.value - The new value.FwkExceptionpublic void setValueAsObject(java.lang.Object item)
throws FwkException
setValueAsObject in interface OdsxPresentableElementInterfacesetValueAsObject in class OdsxPresentableElementitem - the new value.FwkExceptionpublic void getPresentationString(java.io.Writer w,
java.lang.String spec,
java.util.Locale locale,
OdsxFilterInterface filter)
getPresentationString in interface OdsxPresentableElementInterfacegetPresentationString in class OdsxPresentableElementw - The writer.spec - This string allows the caller to specify the kind of output.
Currently there are to values allowed All or Header Only.
The All keyword is the default.
If the keyword Header Only is specify it will print out no values and flags.l - The Locale object or null.f - An ODSFilterInterface object.public void writeEnumerations(java.io.Writer w,
java.lang.String spec,
java.util.Locale locale)
throws AoException,
java.io.IOException
w - The writer.spec - This string allows the caller to specify the kind of output.
Currently there are to values allowed All or Header Only.
The All keyword is the default.
If the keyword Header Only is specify it will print out no values and flags.l - The Locale object or null.f - An ODSFilterInterface object.AoExceptionjava.io.IOExceptionpublic java.util.Vector getElements()
getElements in interface OdsxPresentableElementInterfacegetElements in class OdsxPresentableElementpublic java.lang.String getIdentificationString()
getIdentificationString in interface OdsxPresentableElementInterfacegetIdentificationString in class OdsxPresentableElementpublic FwkCommandInterface[] getCommands()
getCommands in interface FwkInstructionInterfacegetCommands in class OdsxPresentableElement