Package com.evolveum.midpoint.prism

Class PrismPresentationDefinition.Data

java.lang.Object

com.evolveum.midpoint.prism.AbstractFreezable

com.evolveum.midpoint.prism.PrismPresentationDefinition.Data

All Implemented Interfaces:

Freezable, PrismPresentationDefinition, PrismPresentationDefinition.Mutable, Serializable

Enclosing interface:

PrismPresentationDefinition

public static class PrismPresentationDefinition.Data
extends AbstractFreezable
implements PrismPresentationDefinition, PrismPresentationDefinition.Mutable, Serializable

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismPresentationDefinition

PrismPresentationDefinition.Data, PrismPresentationDefinition.Delegable, PrismPresentationDefinition.Mutable

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismPresentationDefinition.Mutable

PrismPresentationDefinition.Mutable.Delegable

Constructor Summary

Constructors

Constructor	Description
Data()

Method Summary

Modifier and Type	Method	Description
void	copyFrom(PrismPresentationDefinition.Data source)
boolean	equals(Object o)
List<ItemDiagramSpecification>	getDiagrams()
DisplayHint	getDisplayHint()	Enumeration annotation that specifies how/whether the item should be displayed.
String	getDisplayName()	Returns display name.
Integer	getDisplayOrder()	Specifies an order in which the item should be displayed relative to other items at the same level.
String	getDocumentation()	Must contains tag because of html tags used in text.
String	getDocumentationPreview()	Returns only a first sentence of documentation.
String	getHelp()	Returns help string.
int	hashCode()
boolean	isEmphasized()	True for definitions that are more important than others and that should be emphasized during presentation.
void	setDiagrams(List<ItemDiagramSpecification> value)
void	setDisplayHint(DisplayHint displayHint)
void	setDisplayName(String displayName)
void	setDisplayOrder(Integer displayOrder)
void	setDocumentation(String documentation)
void	setEmphasized(boolean emphasized)
void	setHelp(String help)

Methods inherited from class com.evolveum.midpoint.prism.AbstractFreezable

freeze, freeze, freezeAll, freezeNullableList, isImmutable, isMutable, performFreeze

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.evolveum.midpoint.prism.Freezable

checkImmutable, checkMutable

Constructor Details

Data

public Data()

Method Details

getDisplayHint

public DisplayHint getDisplayHint()

Description copied from interface: PrismPresentationDefinition

Enumeration annotation that specifies how/whether the item should be displayed. It is also a replacement for the old "emphasized" annotation.

Specified by:

getDisplayHint in interface PrismPresentationDefinition

setDisplayHint

public void setDisplayHint(DisplayHint displayHint)

Specified by:

setDisplayHint in interface PrismPresentationDefinition.Mutable

isEmphasized

public boolean isEmphasized()

Description copied from interface: PrismPresentationDefinition

True for definitions that are more important than others and that should be emphasized during presentation. E.g. the emphasized definitions will always be displayed in the user interfaces (even if they are empty), they will always be included in the dumps, etc. TODO probably deprecated, isn't it?

Specified by:

isEmphasized in interface PrismPresentationDefinition

setEmphasized

public void setEmphasized(boolean emphasized)

Specified by:

setEmphasized in interface PrismPresentationDefinition.Mutable

getDisplayName

public String getDisplayName()

Description copied from interface: PrismPresentationDefinition

Returns display name. Specifies the printable name of the object class or attribute. It must contain a printable string. It may also contain a key to catalog file. Returns null if no display name is set. Corresponds to "displayName" XSD annotation.

Specified by:

getDisplayName in interface PrismPresentationDefinition

Returns:

display name string or catalog key

setDisplayName

public void setDisplayName(String displayName)

Specified by:

setDisplayName in interface PrismPresentationDefinition.Mutable

getDisplayOrder

public Integer getDisplayOrder()

Description copied from interface: PrismPresentationDefinition

Specifies an order in which the item should be displayed relative to other items at the same level. The items will be displayed by sorting them by the values of displayOrder annotation (ascending). Items that do not have any displayOrder annotation will be displayed last. The ordering of values with the same displayOrder is undefined and it may be arbitrary.

Specified by:

getDisplayOrder in interface PrismPresentationDefinition

setDisplayOrder

public void setDisplayOrder(Integer displayOrder)

Specified by:

setDisplayOrder in interface PrismPresentationDefinition.Mutable

getHelp

public String getHelp()

Description copied from interface: PrismPresentationDefinition

Returns help string. Specifies the help text or a key to catalog file for a help text. The help text may be displayed in any suitable way by the GUI. It should explain the meaning of an attribute or object class. Returns null if no help string is set. Corresponds to "help" XSD annotation.

Specified by:

getHelp in interface PrismPresentationDefinition

Returns:

help string or catalog key

setHelp

public void setHelp(String help)

Specified by:

setHelp in interface PrismPresentationDefinition.Mutable

getDocumentation

public String getDocumentation()

Description copied from interface: PrismPresentationDefinition

Must contains tag because of html tags used in text.

Specified by:

getDocumentation in interface PrismPresentationDefinition

setDocumentation

public void setDocumentation(String documentation)

Specified by:

setDocumentation in interface PrismPresentationDefinition.Mutable

getDiagrams

public List<ItemDiagramSpecification> getDiagrams()

Specified by:

getDiagrams in interface PrismPresentationDefinition

setDiagrams

public void setDiagrams(List<ItemDiagramSpecification> value)

Specified by:

setDiagrams in interface PrismPresentationDefinition.Mutable

getDocumentationPreview

public String getDocumentationPreview()

Description copied from interface: PrismPresentationDefinition

Returns only a first sentence of documentation.

Specified by:

getDocumentationPreview in interface PrismPresentationDefinition

copyFrom

public void copyFrom(PrismPresentationDefinition.Data source)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object