Package com.evolveum.midpoint.prism
Interface PrismPresentationDefinition.Delegable
- All Superinterfaces:
PrismPresentationDefinition
- All Known Implementing Classes:
NativeShadowAttributeDefinitionImpl
- Enclosing interface:
- PrismPresentationDefinition
-
Nested Class Summary
Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismPresentationDefinition
PrismPresentationDefinition.Data, PrismPresentationDefinition.Delegable, PrismPresentationDefinition.Mutable -
Method Summary
Modifier and TypeMethodDescriptiondefault List<ItemDiagramSpecification>default DisplayHintEnumeration annotation that specifies how/whether the item should be displayed.default StringReturns display name.default IntegerSpecifies an order in which the item should be displayed relative to other items at the same level.default StringMust containstag because of html tags used in text. default StringReturns only a first sentence of documentation.default StringgetHelp()Returns help string.default booleanTrue for definitions that are more important than others and that should be emphasized during presentation.@NotNull PrismPresentationDefinition
-
Method Details
-
prismPresentationDefinition
-
getDisplayHint
Description copied from interface:PrismPresentationDefinitionEnumeration annotation that specifies how/whether the item should be displayed. It is also a replacement for the old "emphasized" annotation.- Specified by:
getDisplayHintin interfacePrismPresentationDefinition
-
isEmphasized
default boolean isEmphasized()Description copied from interface:PrismPresentationDefinitionTrue 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:
isEmphasizedin interfacePrismPresentationDefinition
-
getDisplayName
Description copied from interface:PrismPresentationDefinitionReturns 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:
getDisplayNamein interfacePrismPresentationDefinition- Returns:
- display name string or catalog key
-
getDisplayOrder
Description copied from interface:PrismPresentationDefinitionSpecifies 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:
getDisplayOrderin interfacePrismPresentationDefinition
-
getHelp
Description copied from interface:PrismPresentationDefinitionReturns 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:
getHelpin interfacePrismPresentationDefinition- Returns:
- help string or catalog key
-
getDocumentation
Description copied from interface:PrismPresentationDefinitionMust containstag because of html tags used in text. - Specified by:
getDocumentationin interfacePrismPresentationDefinition
-
getDiagrams
- Specified by:
getDiagramsin interfacePrismPresentationDefinition
-
getDocumentationPreview
Description copied from interface:PrismPresentationDefinitionReturns only a first sentence of documentation.- Specified by:
getDocumentationPreviewin interfacePrismPresentationDefinition
-