org.openmdx.ui1.jdo2
Class Element

java.lang.Object
  org.oasisopen.jdo2.Identifiable
      org.w3c.jdo2.AbstractObject
          org.openmdx.ui1.jdo2.Element

All Implemented Interfaces:

Serializable, org.openmdx.base.cci2.BasicObject, org.openmdx.base.cci2.ContextCapable, org.openmdx.base.cci2.ExtentCapable, org.openmdx.compatibility.view1.cci2.ViewCapable, Element

Direct Known Subclasses:

AttributePane, CheckBox, CompoundField, DateField, DocumentBox, FieldGroup, Inspector, NumberField, ObjectContainer, ObjectReferenceField, OperationPane, ReferencePane, Tab, TextBox, TextField

public class Element
extends org.w3c.jdo2.AbstractObject
implements Element

Abstract class Element

See Also:

Serialized Form

Nested Class Summary

static class	Element.Identity The object's application identity
static class	Element.Slice Slice object hold the Element's multivalued attributes

Nested classes/interfaces inherited from class org.w3c.jdo2.AbstractObject

org.w3c.jdo2.AbstractObject.EmbeddedList<E>, org.w3c.jdo2.AbstractObject.EmbeddedSet<E>

Field Summary

static List<String>	BASE_CLASS Define this class as base class
static List<String>	CLASS Define the model class org::openmdx::ui1::Element

Constructor Summary

Element()

Method Summary

void	addToSegment(Segment segment) Sets a new value for the reference segment.
void	addToSegment(Segment segment, boolean idIsPersistent, String id) Set the object's composite association org:openmdx:ui1:SegmentContainsElement.
Date	getCreatedAt() Retrieves the value for the attribute createdAt.
Set<String>	getCreatedBy() Retrieves a set containing all the elements for the attribute createdBy.
String	getIconKey() Retrieves the possibly null value for the optional attribute iconKey.
String	getIdentity() Retrieves the value for the attribute identity.
String	getMimeType() Retrieves the possibly null value for the optional attribute mimeType.
Date	getModifiedAt() Retrieves the value for the attribute modifiedAt.
Set<String>	getModifiedBy() Retrieves a set containing all the elements for the attribute modifiedBy.
List<String>	getToolTip() Retrieves a list containing all the elements for the attribute toolTip.
<T extends org.openmdx.compatibility.view1.cci2.View> Collection<T>	getView() Retrieves a set containing all the elements for the reference view.
org.openmdx.compatibility.view1.cci2.View	getView(boolean namespaceIsPersistent, String namespace) Retrieves the value for the reference view for the specified qualifier attribute value.
boolean	isAutoGenerated() Retrieves the value for the attribute autoGenerated.
boolean	isChangeable() Retrieves the value for the attribute changeable.
static Element.Identity	newIdentity(org.openmdx.base.cci2.Segment.Identity segment, boolean idIsPersistent, String id)
protected org.w3c.jdo2.AbstractObject.Slice	newSlice(int index)
protected List<String>	openmdxjdoGetClass() Retrieve the model class
protected String	openmdxjdoGetObjectId() Retrieve the object's JDO identity key
static org.w3c.cci2.CloseableCollection<Element>	openmdxjdoGetObjectsByParent(Segment segment) Navigate through an object's composite association
protected int	openmdxjdoGetSize(int field)
protected <E extends org.w3c.jdo2.AbstractObject.Slice> SortedMap<Integer,E>	openmdxjdoGetSlices()
protected void	openmdxjdoSetSize(int field, int size)
static Element.Identity	openmdxjdoToIdentity(org.oasisopen.spi2.ObjectId objectId)
void	setAutoGenerated(boolean autoGenerated) Sets a new value for the attribute autoGenerated.
void	setChangeable(boolean changeable) Sets a new value for the attribute changeable.
void	setIconKey(String iconKey) Sets a new value for the attribute iconKey.
void	setMimeType(String mimeType) Sets a new value for the attribute mimeType.
void	setToolTip(String... toolTip) Clears toolTip and adds the given value(s).

Methods inherited from class org.w3c.jdo2.AbstractObject

openmdxjdoClassName, openmdxjdoGetIdentityBuilder, openmdxjdoGetList, openmdxjdoGetObjectsByParent, openmdxjdoGetSet, openmdxjdoGetSparseArray, openmdxjdoNewSlice, openmdxjdoSetArray, openmdxjdoSetCollection, openmdxjdoToArray, openmdxjdoToArray, openmdxjdoValidateElement

Methods inherited from class org.oasisopen.jdo2.Identifiable

openmdxjdoGetObject, openmdxjdoGetObjectById, openmdxjdoGetObjectId, openmdxjdoGetObjectSet, openmdxjdoNewObjectId, openmdxjdoNewObjectId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CLASS

public static final List<String> CLASS

Define the model class org::openmdx::ui1::Element

BASE_CLASS

public static final List<String> BASE_CLASS

Define this class as base class

See Also:

Element.CLASS

Constructor Detail

Element

public Element()

Method Detail

openmdxjdoGetObjectId

protected String openmdxjdoGetObjectId()

Retrieve the object's JDO identity key

Specified by:

openmdxjdoGetObjectId in class org.oasisopen.jdo2.Identifiable

Returns:

the value of the object's JDO identity key

openmdxjdoGetSlices

protected final <E extends org.w3c.jdo2.AbstractObject.Slice> SortedMap<Integer,E> openmdxjdoGetSlices()

Overrides:

openmdxjdoGetSlices in class org.w3c.jdo2.AbstractObject

getModifiedAt

public Date getModifiedAt()

Retrieves the value for the attribute modifiedAt.

Specified by:

getModifiedAt in interface org.openmdx.base.cci2.BasicObject

Returns:

The non-null value for attribute modifiedAt.

getModifiedBy

public final Set<String> getModifiedBy()

Retrieves a set containing all the elements for the attribute modifiedBy.

Specified by:

getModifiedBy in interface org.openmdx.base.cci2.BasicObject

Returns:

A set containing all elements for this attribute.

getToolTip

public final List<String> getToolTip()

Retrieves a list containing all the elements for the attribute toolTip.

Specified by:

getToolTip in interface Element

Returns:

A list containing all elements for this attribute.

setToolTip

public void setToolTip(String... toolTip)

Clears toolTip and adds the given value(s).

This method is equivalent to

   list.clear();
   for(java.lang.String e : attributeName){
     list.add(e);
   }
 

Specified by:

setToolTip in interface Element

Parameters:

toolTip - value(s) to be added to toolTip

getIdentity

public String getIdentity()

Retrieves the value for the attribute identity.

Specified by:

getIdentity in interface org.openmdx.base.cci2.ExtentCapable

Returns:

The non-null value for attribute identity.

getCreatedBy

public final Set<String> getCreatedBy()

Retrieves a set containing all the elements for the attribute createdBy.

Specified by:

getCreatedBy in interface org.openmdx.base.cci2.BasicObject

Returns:

A set containing all elements for this attribute.

getCreatedAt

public Date getCreatedAt()

Retrieves the value for the attribute createdAt.

Specified by:

getCreatedAt in interface org.openmdx.base.cci2.BasicObject

Returns:

The non-null value for attribute createdAt.

getView

public <T extends org.openmdx.compatibility.view1.cci2.View> Collection<T> getView()

Retrieves a set containing all the elements for the reference view.

Specified by:

getView in interface org.openmdx.compatibility.view1.cci2.ViewCapable

Returns:

A set containing all the elements for this reference.

getView

public org.openmdx.compatibility.view1.cci2.View getView(boolean namespaceIsPersistent,
                                                         String namespace)

Retrieves the value for the reference view for the specified qualifier attribute value.

Specified by:

getView in interface org.openmdx.compatibility.view1.cci2.ViewCapable

Parameters:

namespaceIsPersistent - Defines whether value for the qualifier is persistent or not

namespace - The value for the qualifier attribute that qualifies this reference.

Returns:

The possibly null value for this qualifier

getIconKey

public final String getIconKey()

Retrieves the possibly null value for the optional attribute iconKey.

Specified by:

getIconKey in interface Element

Returns:

The possibly null value for attribute iconKey.

setIconKey

public void setIconKey(String iconKey)

Sets a new value for the attribute iconKey.

Specified by:

setIconKey in interface Element

Parameters:

iconKey - The possibly null new value for attribute iconKey.

isAutoGenerated

public boolean isAutoGenerated()

Retrieves the value for the attribute autoGenerated.

Specified by:

isAutoGenerated in interface Element

Returns:

The non-null value for attribute autoGenerated.

setAutoGenerated

public void setAutoGenerated(boolean autoGenerated)

Sets a new value for the attribute autoGenerated.

Specified by:

setAutoGenerated in interface Element

Parameters:

autoGenerated - The non-null new value for attribute autoGenerated.

getMimeType

public final String getMimeType()

Retrieves the possibly null value for the optional attribute mimeType.

Specified by:

getMimeType in interface Element

Returns:

The possibly null value for attribute mimeType.

setMimeType

public void setMimeType(String mimeType)

Sets a new value for the attribute mimeType.

Specified by:

setMimeType in interface Element

Parameters:

mimeType - The possibly null new value for attribute mimeType.

isChangeable

public boolean isChangeable()

Retrieves the value for the attribute changeable.

Specified by:

isChangeable in interface Element

Returns:

The non-null value for attribute changeable.

setChangeable

public void setChangeable(boolean changeable)

Sets a new value for the attribute changeable.

Specified by:

setChangeable in interface Element

Parameters:

changeable - The non-null new value for attribute changeable.

openmdxjdoGetSize

protected int openmdxjdoGetSize(int field)

Overrides:

openmdxjdoGetSize in class org.w3c.jdo2.AbstractObject

openmdxjdoSetSize

protected void openmdxjdoSetSize(int field,
                                 int size)

Overrides:

openmdxjdoSetSize in class org.w3c.jdo2.AbstractObject

newSlice

protected org.w3c.jdo2.AbstractObject.Slice newSlice(int index)

openmdxjdoGetClass

protected List<String> openmdxjdoGetClass()

Retrieve the model class

Returns:

the model class

See Also:

Element.CLASS

addToSegment

public void addToSegment(Segment segment)

Sets a new value for the reference segment.

Parameters:

segment - The non-null new value for this reference.

openmdxjdoGetObjectsByParent

public static org.w3c.cci2.CloseableCollection<Element> openmdxjdoGetObjectsByParent(Segment segment)

Navigate through an object's composite association

addToSegment

public void addToSegment(Segment segment,
                         boolean idIsPersistent,
                         String id)

Set the object's composite association org:openmdx:ui1:SegmentContainsElement.

Parameters:

segment - The non-null new value for this object's composite owner.

idIsPersistent - Defines whether the id is persistent.

id - The non-null new value for this object's qualifier.

newIdentity

public static Element.Identity newIdentity(org.openmdx.base.cci2.Segment.Identity segment,
                                           boolean idIsPersistent,
                                           String id)

openmdxjdoToIdentity

public static Element.Identity openmdxjdoToIdentity(org.oasisopen.spi2.ObjectId objectId)