public abstract class Field extends ObjectElement
Constructor and Description |
---|
Field(java.lang.String name,
java.lang.String displayname,
java.lang.String tooltip)
creates a new field
|
Field(java.lang.String name,
java.lang.String displayname,
java.lang.String tooltip,
int displaypriority)
creates a new field with the given priority
|
Modifier and Type | Method and Description |
---|---|
Field |
copy()
performs a copy of the field
|
abstract Field |
copy(java.lang.String newname,
java.lang.String newdisplaylabel)
performs a copy of the field with new name and new display label
|
int |
getDisplayPriority() |
abstract StoredElement |
getMainStoredElementForCompositeIndex()
Returns the main stored element of a field to be used in composite index
|
DataObjectDefinition |
getParentObject() |
boolean |
isNoUserEdition() |
boolean |
isShowinbottomnotes() |
boolean |
isShowintitle() |
protected void |
setDataObjectDefinition(DataObjectDefinition parentobject)
set the parent data object on this field
|
void |
setDisplayPriority(int displaypriority)
set the display priority of the field
|
void |
setNoUserEdition()
If this is set, the only way to update this field is through actions and
triggers.
|
void |
setShowinbottomnotes()
if true, the field is shown in bottom notes
|
void |
setShowInTitle()
if true, the field is shown in title and in main object field on the object
page
|
addElement, AddElementWithSearch, addIndex, getDataObjectConstructorAttributes, getDataObjectFieldName, getDisplayname, getElements, getIndex, getJavaType, getSearchWidgetList, getTooltip, writeDependentClass
changeName, cleanName, equals, getName
public Field(java.lang.String name, java.lang.String displayname, java.lang.String tooltip)
name
- unique identification that should be valid in java and sqldisplayname
- label of the field that is shown to the users in the
default languagetooltip
- roll-over tooltip explaining the fieldpublic Field(java.lang.String name, java.lang.String displayname, java.lang.String tooltip, int displaypriority)
name
- unique identification that should be valid in java and
sqldisplayname
- label of the field that is shown to the users in the
default languagetooltip
- roll-over tooltip explaining the fielddisplaypriority
- display priority for the fieldpublic void setNoUserEdition()
public boolean isNoUserEdition()
public DataObjectDefinition getParentObject()
protected void setDataObjectDefinition(DataObjectDefinition parentobject)
parentobject
- the parent data objectpublic void setShowInTitle()
public void setShowinbottomnotes()
public boolean isShowintitle()
public boolean isShowinbottomnotes()
public void setDisplayPriority(int displaypriority)
displaypriority
- display prioritypublic int getDisplayPriority()
public abstract StoredElement getMainStoredElementForCompositeIndex()
public Field copy()
public abstract Field copy(java.lang.String newname, java.lang.String newdisplaylabel)
newname
- newname for the field (null if keep originalname)newdisplaylabel
- new display label (null to keep original display name)