org.modelsphere.jack.baseDb.db
Class DbSingleZoneDisplay

java.lang.Object
  extended by PersistentObject
      extended by org.modelsphere.jack.baseDb.db.DbObject
          extended by org.modelsphere.jack.baseDb.db.DbZoneDisplay
              extended by org.modelsphere.jack.baseDb.db.DbSingleZoneDisplay
Direct Known Subclasses:
DbBESingleZoneDisplay

public abstract class DbSingleZoneDisplay
extends DbZoneDisplay

Defines display attributes of a single zone for graphical objects. A single zone contains only one element (for instance the zone to display the name of a process), as opposite to multi-valued zones that contain several element. This is an element contained in a notation. See DbBESingleZoneDisplay in sms.be.db for a concrete class that extends a DbZoneDisplay.


Nested Class Summary
 
Nested classes/interfaces inherited from class org.modelsphere.jack.baseDb.db.DbObject
DbObject.ComponentIterator
 
Field Summary
static MetaField fJustification
           
static MetaField fMetaField
           
static MetaField fSeparator
           
static MetaRelation1 fUdf
           
static MetaField fUseExtraSpace
           
static MetaClass metaClass
           
 
Fields inherited from class org.modelsphere.jack.baseDb.db.DbZoneDisplay
fDisplayed
 
Fields inherited from class org.modelsphere.jack.baseDb.db.DbObject
ACCESS_GRANTED, ACCESS_NOT_GRANTED, fComponents, fComposite, fCreationTime, fModificationTime, fUdfValues, fValidationStatus, LONG_FORM, SHORT_FORM, VALIDATION_ERROR, VALIDATION_OK, VALIDATION_WARNING, writeAccess
 
Constructor Summary
DbSingleZoneDisplay()
          Parameter-less constructor.
DbSingleZoneDisplay(DbObject composite)
          Creates an instance of DbSingleZoneDisplay.
DbSingleZoneDisplay(DbObject composite, boolean displayed, ZoneJustification justification, boolean separator)
          Creates an empty instance of DbSingleZoneDisplay.
DbSingleZoneDisplay(DbObject composite, DbUDF udf, boolean displayed, ZoneJustification justification, boolean separator)
          Creates an instance of DbSingleZoneDisplay.
DbSingleZoneDisplay(DbObject composite, MetaField metaField, boolean displayed, ZoneJustification justification, boolean separator)
          Creates an instance of DbSingleZoneDisplay.
 
Method Summary
 java.lang.String getGUIName()
          Get Field GUIName or UDF Name
 ZoneJustification getJustification()
          Gets the "justification" of a DbZoneDisplay's instance.
 MetaClass getMetaClass()
           
 MetaField getMetaField()
          Gets the metafield object associated to a DbDisplayField's instance.
 java.lang.Boolean getSeparator()
          Deprecated. use isSeparator() method instead
 java.lang.Object getSourceObject()
          Gets the source object associated to a DbDisplayField's instance.
 DbUDF getUdf()
          Gets the udf object associated to a DbDisplayField's instance.
 java.lang.Boolean getUseExtraSpace()
          Deprecated. use isUseExtraSpace() method instead
 java.lang.Object getValue(DbObject dbo)
          Get the value of the MetaField or the UDF
static void initMeta()
          For internal use only.
 boolean isEmpty()
          Tells whether a DbZoneDisplay's instance is empty or not.
 boolean isSeparator()
          Tells whether a DbZoneDisplay's instance is separator or not.
 boolean isUseExtraSpace()
          Tells whether a DbZoneDisplay's instance is useExtraSpace or not.
 void set(MetaField metaField, java.lang.Object value)
          Deprecated. use the appropriate setXXX() method instead.
 void set(MetaRelationN relation, DbObject neighbor, int op)
          Deprecated. use the appropriate addToXXX() or removeFromXXX() method instead.
 void setJustification(ZoneJustification value)
          Sets the "justification" property of a DbZoneDisplay's instance.
 void setMetaField(MetaField value)
          Sets the metafield object associated to a DbDisplayField's instance.
 void setSeparator(java.lang.Boolean value)
          Sets the "separator" property of a DbZoneDisplay's instance.
 void setUdf(DbUDF value)
          Sets the udf object associated to a DbDisplayField's instance.
 void setUseExtraSpace(java.lang.Boolean value)
          Sets the "useExtraSpace" property of a DbZoneDisplay's instance.
 
Methods inherited from class org.modelsphere.jack.baseDb.db.DbZoneDisplay
getDisplayed, isDisplayed, setDisplayed
 
Methods inherited from class org.modelsphere.jack.baseDb.db.DbObject
addDbRefreshListener, addDbRefreshListener, basicReinsert, basicSet, basicSet, buildFullNameString, buildFullNameString, componentTree, componentTree, componentTree, copyComponent, createComponent, createComponent, createRAMRelN, deepCopy, deepCopy, doDeleteAction, findComponentByName, findComponentByName, findMatchingObject, generateEDCTimestamp, get, get, get, getAccordingToStatus, getComponents, getComposite, getCompositeOfType, getCreationTime, getDb, getDependencyRelations, getEDCTimestamp, getFullDisplayName, getId, getMatchingObject, getMinCard, getModificationTime, getName, getNbNeighbors, getNextTs, getOld, getProject, getSemanticalIcon, getSemanticalName, getTransStatus, getTs, getUDF, getUdfValues, getValidationStatus, hasAdminAccess, hasChanged, hasField, hasWriteAccess, isAddedAndRemoved, isAlive, isDeletable, isDescendingFrom, isHugeRelN, load, load, matches, reinsert, remove, removeDbRefreshListener, save, set, setComposite, setMatchingObject, setModificationTime, setName, setRelationNN, setRelationNN, setValidationStatus, toString, valuesAreEqual
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

fJustification

public static final MetaField fJustification

fSeparator

public static final MetaField fSeparator

fUseExtraSpace

public static final MetaField fUseExtraSpace

fMetaField

public static final MetaField fMetaField

fUdf

public static final MetaRelation1 fUdf

metaClass

public static final MetaClass metaClass
Constructor Detail

DbSingleZoneDisplay

public DbSingleZoneDisplay()
Parameter-less constructor. Required by Java Beans Conventions.


DbSingleZoneDisplay

public DbSingleZoneDisplay(DbObject composite)
                    throws DbException
Creates an instance of DbSingleZoneDisplay.

Parameters:
composite - the object which will contain the newly-created instance
Throws:
DbException

DbSingleZoneDisplay

public DbSingleZoneDisplay(DbObject composite,
                           MetaField metaField,
                           boolean displayed,
                           ZoneJustification justification,
                           boolean separator)
                    throws DbException
Creates an instance of DbSingleZoneDisplay.

Parameters:
composite - the object which will contain the newly-created instance
MetaField - metaField
boolean - displayed
ZoneJustification -
justification -
boolean - separator
Throws:
DbException

DbSingleZoneDisplay

public DbSingleZoneDisplay(DbObject composite,
                           DbUDF udf,
                           boolean displayed,
                           ZoneJustification justification,
                           boolean separator)
                    throws DbException
Creates an instance of DbSingleZoneDisplay.

Parameters:
composite - the object which will contain the newly-created instance
DbUDF - udf
boolean - displayed
ZoneJustification - justification
boolean - separator
Throws:
DbException

DbSingleZoneDisplay

public DbSingleZoneDisplay(DbObject composite,
                           boolean displayed,
                           ZoneJustification justification,
                           boolean separator)
                    throws DbException
Creates an empty instance of DbSingleZoneDisplay.

Parameters:
composite - the object which will contain the newly-created instance
boolean - displayed
ZoneJustification - justification
boolean - separator
Throws:
DbException
Method Detail

initMeta

public static void initMeta()
For internal use only.


setMetaField

public final void setMetaField(MetaField value)
                        throws DbException
Sets the metafield object associated to a DbDisplayField's instance.

Parameters:
value - the metafield object to be set
Throws:
DbException

setUdf

public final void setUdf(DbUDF value)
                  throws DbException
Sets the udf object associated to a DbDisplayField's instance.

Parameters:
value - the udf object to be associated
Throws:
DbException

setJustification

public final void setJustification(ZoneJustification value)
                            throws DbException
Sets the "justification" property of a DbZoneDisplay's instance.

Parameters:
value - the "justification" property
Throws:
DbException

setSeparator

public final void setSeparator(java.lang.Boolean value)
                        throws DbException
Sets the "separator" property of a DbZoneDisplay's instance.

Parameters:
value - the "separator" property
Throws:
DbException

setUseExtraSpace

public final void setUseExtraSpace(java.lang.Boolean value)
                            throws DbException
Sets the "useExtraSpace" property of a DbZoneDisplay's instance.

Parameters:
value - the "useExtraSpace" property
Throws:
DbException

set

public void set(MetaField metaField,
                java.lang.Object value)
         throws DbException
Deprecated. use the appropriate setXXX() method instead.

Overrides:
set in class DbZoneDisplay
Throws:
DbException

set

public void set(MetaRelationN relation,
                DbObject neighbor,
                int op)
         throws DbException
Deprecated. use the appropriate addToXXX() or removeFromXXX() method instead.

Overrides:
set in class DbZoneDisplay
Throws:
DbException

getGUIName

public final java.lang.String getGUIName()
                                  throws DbException
Get Field GUIName or UDF Name

Returns:
String: the name.
Throws:
DbException

getValue

public final java.lang.Object getValue(DbObject dbo)
                                throws DbException
Get the value of the MetaField or the UDF

Returns:
Object: the value
Throws:
DbException

getMetaField

public final MetaField getMetaField()
                             throws DbException
Gets the metafield object associated to a DbDisplayField's instance.

Returns:
the metafield object
Throws:
DbException

getUdf

public final DbUDF getUdf()
                   throws DbException
Gets the udf object associated to a DbDisplayField's instance.

Returns:
the udf object
Throws:
DbException

getSourceObject

public final java.lang.Object getSourceObject()
                                       throws DbException
Gets the source object associated to a DbDisplayField's instance.

Returns:
the source object
Throws:
DbException

getJustification

public final ZoneJustification getJustification()
                                         throws DbException
Gets the "justification" of a DbZoneDisplay's instance.

Returns:
the "justification"
Throws:
DbException

getSeparator

public final java.lang.Boolean getSeparator()
                                     throws DbException
Deprecated. use isSeparator() method instead

Gets the "separator" property's Boolean value of a DbZoneDisplay's instance.

Returns:
the "separator" property's Boolean value
Throws:
DbException

getUseExtraSpace

public final java.lang.Boolean getUseExtraSpace()
                                         throws DbException
Deprecated. use isUseExtraSpace() method instead

Gets the "useExtraSpace" property's Boolean value of a DbZoneDisplay's instance.

Returns:
the "useExtraSpace" property's Boolean value
Throws:
DbException

isSeparator

public final boolean isSeparator()
                          throws DbException
Tells whether a DbZoneDisplay's instance is separator or not.

Returns:
boolean
Throws:
DbException

isUseExtraSpace

public final boolean isUseExtraSpace()
                              throws DbException
Tells whether a DbZoneDisplay's instance is useExtraSpace or not.

Returns:
boolean
Throws:
DbException

isEmpty

public final boolean isEmpty()
                      throws DbException
Tells whether a DbZoneDisplay's instance is empty or not.

Returns:
boolean
Throws:
DbException

getMetaClass

public MetaClass getMetaClass()
Overrides:
getMetaClass in class DbZoneDisplay


Open ModelSphere 2007. All Rights Reserved.