org.apache.isis.core.metamodel.facets.object.title

Interface TitleFacet

All Superinterfaces:

Facet

All Known Implementing Classes:

TitleFacetAbstract, TitleFacetBasedOnMask, TitleFacetFormattedByRegex, TitleFacetNone, TitleFacetUsingParser, TitleFacetViaTitleAnnotation, TitleFacetViaTitleMethod, TitleFacetViaToStringMethod

public interface TitleFacet
extends Facet

Mechanism for obtaining the title of an instance of a class, used to label the instance in the viewer (usually alongside an icon representation).

In the standard Apache Isis Programming Model, typically corresponds to a method named title.

See Also:

IconFacet, PluralFacet

Method Summary

Methods

Modifier and Type	Method and Description
String	title(ObjectAdapter targetAdapter, org.apache.isis.applib.profiles.Localization localization) Provide a title for the target object, with respect to the specified Localization.
String	title(ObjectAdapter contextAdapter, ObjectAdapter targetAdapter, org.apache.isis.applib.profiles.Localization localization) Provide a title for the target object, in the context of the context object, with respect to the specified Localization.

Methods inherited from interface org.apache.isis.core.metamodel.facetapi.Facet

alwaysReplace, facetType, getFacetHolder, getUnderlyingFacet, isDerived, isNoop, setFacetHolder, setUnderlyingFacet

Method Detail

title

String title(ObjectAdapter targetAdapter,
           org.apache.isis.applib.profiles.Localization localization)

Provide a title for the target object, with respect to the specified Localization.

title

String title(ObjectAdapter contextAdapter,
           ObjectAdapter targetAdapter,
           org.apache.isis.applib.profiles.Localization localization)

Provide a title for the target object, in the context of the context object, with respect to the specified Localization.

For example, if the title is of an object within a parented collection, then the context object would be the parent. Thus, the title might be shortened so that it does not needlessly incorporate the title of the parent (context) object.