Package adalid.core

Class Display

java.lang.Object

adalid.core.AbstractArtifact

adalid.core.Display

All Implemented Interfaces:

Wrappable, Artifact, Comparable<Display>

Direct Known Subclasses:

Form, Page

public abstract class Display
extends AbstractArtifact
implements Comparable<Display>

Author:

Jorge Campins

Field Summary

Fields inherited from class adalid.core.AbstractArtifact

ENGLISH, NBSP, PORTUGUESE, SPANISH

Constructor Summary

Constructors

Constructor	Description
Display(String name)

Method Summary

Modifier and Type	Method	Description
int	compareTo(Display o)
protected String	fieldsToString(int n, String key, boolean verbose, boolean fields, boolean maps)
List<Display>	getChildren()
List<Display>	getCollaterals()
DisplayFormat	getDisplayFormat()
DisplayMode	getDisplayMode()
DisplaySet	getDisplaySet()
DisplayType	getDisplayType()
Entity	getEntity()
List<String>	getFieldNames()
abstract List<? extends DisplayField>	getFields()
String	getHelpDocument()
String	getHelpFileName()
List<String>	getJoinFieldNames()
List<? extends DisplayField>	getJoinFields()
Entity	getMaster()
abstract List<? extends DisplayField>	getMasterHeadingFields()
QueryTable	getMasterQueryTable()
Project	getModule()
List<Entity>	getOverlayEntitiesList()
QueryTable	getQueryTable()
EntityReference	getReference()
BooleanExpression	getRenderingFilter()
List<String>	getRootFieldNames()
List<? extends DisplayField>	getRootFields()
List<? extends DisplayField>	getRootFields(Step step)
List<? extends DisplayField>	getRootFields(Tab tab)
List<? extends DisplayField>	getRootMasterHeadingFields()
List<Display>	getSiblings()
boolean	isMenuOptionEnabled()
void	setDisplayFormat(DisplayFormat displayFormat)
void	setDisplayMode(DisplayMode displayMode)
void	setDisplaySet(DisplaySet set)
void	setEntity(Entity entity)
void	setHelpDocument(String document)
void	setHelpFileName(String fileName)
void	setMaster(Entity master)
void	setMasterQueryTable(QueryTable queryTable)
void	setModule(Project module)
void	setQueryTable(QueryTable queryTable)
void	setReference(EntityReference reference)
void	setRenderingFilter(BooleanExpression renderingFilter)	El método setRenderingFilter se utiliza para establecer el filtro de presentación de vistas (páginas) de registro y consulta.

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, mapsToString, 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

Display

public Display(String name)

Method Detail

isMenuOptionEnabled

public boolean isMenuOptionEnabled()

getHelpDocument

public String getHelpDocument()

Returns:

the help file name

setHelpDocument

public void setHelpDocument(String document)

getHelpFileName

public String getHelpFileName()

Returns:

the help file name

setHelpFileName

public void setHelpFileName(String fileName)

getModule

public Project getModule()

Returns:

the module

setModule

public void setModule(Project module)

Parameters:

module - the module to set

getDisplaySet

public DisplaySet getDisplaySet()

Returns:

the display set

setDisplaySet

public void setDisplaySet(DisplaySet set)

Parameters:

set - the display set to set

getEntity

public Entity getEntity()

Returns:

the entity

setEntity

public void setEntity(Entity entity)

Parameters:

entity - the entity to set

getReference

public EntityReference getReference()

Returns:

the entity reference

setReference

public void setReference(EntityReference reference)

Parameters:

reference - the reference to set

getMaster

public Entity getMaster()

Returns:

the master

setMaster

public void setMaster(Entity master)

Parameters:

master - the master to set

getQueryTable

public QueryTable getQueryTable()

Returns:

the query table

setQueryTable

public void setQueryTable(QueryTable queryTable)

Parameters:

queryTable - the query table to set

getMasterQueryTable

public QueryTable getMasterQueryTable()

Returns:

the master query table

setMasterQueryTable

public void setMasterQueryTable(QueryTable queryTable)

Parameters:

queryTable - the master query table to set

getDisplayType

public DisplayType getDisplayType()

Returns:

the display type

getDisplayMode

public DisplayMode getDisplayMode()

Returns:

the display mode

setDisplayMode

public void setDisplayMode(DisplayMode displayMode)

Parameters:

displayMode - the display mode to set

getDisplayFormat

public DisplayFormat getDisplayFormat()

Returns:

the display format

setDisplayFormat

public void setDisplayFormat(DisplayFormat displayFormat)

Parameters:

displayFormat - the display format to set

getRenderingFilter

public BooleanExpression getRenderingFilter()

Returns:

the rendering filter

setRenderingFilter

public void setRenderingFilter(BooleanExpression renderingFilter)

El método setRenderingFilter se utiliza para establecer el filtro de presentación de vistas (páginas) de registro y consulta. Solo si se cumplen los criterios del filtro, la vista (página) será presentada.

Parameters:

renderingFilter - expresión booleana que se utiliza como filtro

getSiblings

public List<Display> getSiblings()

Returns:

the siblings list

getChildren

public List<Display> getChildren()

Returns:

the children list

getCollaterals

public List<Display> getCollaterals()

Returns:

the collaterals list

getFields

public abstract List<? extends DisplayField> getFields()

Returns:

the fields list

getMasterHeadingFields

public abstract List<? extends DisplayField> getMasterHeadingFields()

Returns:

the master heading fields list

getFieldNames

public List<String> getFieldNames()

getRootFields

public List<? extends DisplayField> getRootFields()

getRootFields

public List<? extends DisplayField> getRootFields(Step step)

getRootFields

public List<? extends DisplayField> getRootFields(Tab tab)

getRootMasterHeadingFields

public List<? extends DisplayField> getRootMasterHeadingFields()

getRootFieldNames

public List<String> getRootFieldNames()

getJoinFields

public List<? extends DisplayField> getJoinFields()

getJoinFieldNames

public List<String> getJoinFieldNames()

getOverlayEntitiesList

public List<Entity> getOverlayEntitiesList()

compareTo

public int compareTo(Display o)

Specified by:

compareTo in interface Comparable<Display>

fieldsToString

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

Overrides:

fieldsToString in class AbstractArtifact