Package adalid.core

Class DisplayField

java.lang.Object

adalid.core.AbstractArtifact

adalid.core.DisplayField

All Implemented Interfaces:

Wrappable, Artifact, Comparable<DisplayField>

Direct Known Subclasses:

FormField, PageField

public abstract class DisplayField
extends AbstractArtifact
implements Comparable<DisplayField>

Author:

Jorge Campins

Field Summary

Fields inherited from class adalid.core.AbstractArtifact

ENGLISH, NBSP, PORTUGUESE, SPANISH

Constructor Summary

Constructors

Constructor	Description
DisplayField(Display display, EntityCollection collection)
DisplayField(Display display, Property property)
DisplayField(Display display, QueryTable queryTable, Property property, DisplayField parentField)

Method Summary

Modifier and Type	Method	Description
int	compareTo(DisplayField o)
protected String	fieldsToString(int n, String key, boolean verbose, boolean fields, boolean maps)
Artifact	getArtifact()
List<DisplayField>	getChildren()
DataArtifact	getDataArtifact()
Display	getDisplay()
EntityCollection	getEntityCollection()
DisplayField	getForeignCodeField()
DisplayField	getForeignNameField()
Parameter	getParameter()
DisplayField	getParent()
Property	getProperty()
Step	getStep()
int	getStepFieldIndex()
int	getTabFieldIndex(Tab tab)
Map<Tab,Integer>	getTabs()
boolean	isDataArtifact()
boolean	isEntityCollection()
boolean	isForeignCode()
boolean	isForeignName()
boolean	isInTab(Tab tab)
boolean	isParameter()
boolean	isProperty()
protected String	mapsToString(int n, String key, boolean verbose, boolean fields, boolean maps)
void	setForeignCode(boolean indicator)
void	setForeignName(boolean indicator)

Methods inherited from class adalid.core.AbstractArtifact

addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, addAttributes, annotate, checkName, classToString, clearAttributes, coalesce, copyLocalizedStrings, defaultLocale, depth, fa, finalise, getAlias, getAttribute, getAttribute, getAttributes, getAttributesArray, getAttributesArray, getAttributesKeySetByRegex, getBooleanAttribute, getBooleanAttribute, getClassPath, getDeclaringArtifact, getDeclaringEntity, getDeclaringEntityRoot, getDeclaringField, getDeclaringFieldEntityRoot, getDeclaringFieldIndex, getDeclaringFieldNamedClassSimpleName, getDeclaringFieldPersistentEntityRoot, getDeclaringFieldPersistentEntityTableRoot, getDeclaringOperation, getDeclaringPersistentEntity, getDeclaringPersistentEntityRoot, getDefaultCollectionLabel, getDefaultCollectionShortLabel, getDefaultDescription, getDefaultLabel, getDefaultLocale, getDefaultShortDescription, getDefaultShortLabel, getDefaultSymbol, getDefaultTooltip, getDefaultWrapperClass, getFullName, getIntegerAttribute, getIntegerAttribute, getIntegerAttribute, getIntegerAttribute, getKeyValuePairAttribute, getKeyValuePairAttribute, getKeyValuePairAttribute, getKeyValuePairAttribute, getLocalizedCollectionLabel, getLocalizedCollectionShortLabel, getLocalizedDescription, getLocalizedLabel, getLocalizedShortDescription, getLocalizedShortLabel, getLocalizedSymbol, getLocalizedTooltip, getName, getPartialName, getPathList, getPathString, getSqlName, getStringAttribute, getStringAttribute, getStringAttribute, getStringAttribute, getTrace, getValidFieldAnnotations, getValidTypeAnnotations, getValueString, getValueString, getWrapper, hashCodeHexString, isAnnotated, isClassInPath, isDeclared, isExpression, isFinalised, isFontAwesomeClass, isInherited, isInheritedFromAbstract, isInheritedFromConcrete, isLocalizedSymbolDefined, isNotDeclared, isNotInherited, isNotInheritedFromAbstract, isNotInheritedFromConcrete, isOperation, isValidEmbeddedDocument, isValidFieldAnnotation, isValidHelpFileName, isValidHelpFileType, isValidJavaClassName, isValidSnippetFileName, isValidTypeAnnotation, localeReadingKey, localeWritingKey, put, repeat, round, setAlias, setDefaultCollectionLabel, setDefaultCollectionShortLabel, setDefaultDescription, setDefaultLabel, setDefaultShortDescription, setDefaultShortLabel, setDefaultSymbol, setDefaultTooltip, setLocalizedCollectionLabel, setLocalizedCollectionShortLabel, setLocalizedDescription, setLocalizedLabel, setLocalizedShortDescription, setLocalizedShortLabel, setLocalizedSymbol, setLocalizedTooltip, setSqlName, setStaticAttributes, settler, setTrace, specified, specified, specified, specified, specified, specified, toString, toString, toString, toString, toString, verifyExpression, verifyExpression, verifyExpression, verifyExpression, verifyExpression, verifyExpression, verifyNames

Methods inherited from class java.lang.Object

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

Constructor Detail

DisplayField

public DisplayField(Display display,
                    EntityCollection collection)

DisplayField

public DisplayField(Display display,
                    Property property)

DisplayField

public DisplayField(Display display,
                    QueryTable queryTable,
                    Property property,
                    DisplayField parentField)

Method Detail

getDisplay

public Display getDisplay()

Returns:

the display

getArtifact

public Artifact getArtifact()

Returns:

the linked artifact

getDataArtifact

public DataArtifact getDataArtifact()

Returns:

the linked data artifact

isDataArtifact

public boolean isDataArtifact()

Returns:

true if data artifact is not null

getParameter

public Parameter getParameter()

Returns:

the linked parameter

isParameter

public boolean isParameter()

Returns:

true if data artifact is a parameter

getProperty

public Property getProperty()

Returns:

the linked property

isProperty

public boolean isProperty()

Returns:

true if data artifact is a property

getEntityCollection

public EntityCollection getEntityCollection()

Returns:

the entity collection

isEntityCollection

public boolean isEntityCollection()

Returns:

true if entity collection is not null

getParent

public DisplayField getParent()

Returns:

the parent field

getStep

public Step getStep()

Returns:

the step

getStepFieldIndex

public int getStepFieldIndex()

Returns:

the step field index

getTabs

public Map<Tab,Integer> getTabs()

Returns:

the tab

isInTab

public boolean isInTab(Tab tab)

Parameters:

tab - the tab to search

Returns:

true if the tab contains this field

getTabFieldIndex

public int getTabFieldIndex(Tab tab)

Parameters:

tab - the tab to search

Returns:

the tab field index

isForeignCode

public boolean isForeignCode()

Returns:

the foreign code indicator

setForeignCode

public void setForeignCode(boolean indicator)

Parameters:

indicator - the foreign code indicator to set

getForeignCodeField

public DisplayField getForeignCodeField()

isForeignName

public boolean isForeignName()

Returns:

the foreign name indicator

setForeignName

public void setForeignName(boolean indicator)

Parameters:

indicator - the foreign name indicator to set

getForeignNameField

public DisplayField getForeignNameField()

getChildren

public List<DisplayField> getChildren()

Returns:

the children

compareTo

public int compareTo(DisplayField o)

Specified by:

compareTo in interface Comparable<DisplayField>

fieldsToString

protected String fieldsToString(int n,
                                String key,
                                boolean verbose,
                                boolean fields,
                                boolean maps)

Overrides:

fieldsToString in class AbstractArtifact

mapsToString

protected String mapsToString(int n,
                              String key,
                              boolean verbose,
                              boolean fields,
                              boolean maps)

Overrides:

mapsToString in class AbstractArtifact