LEONARDI Application Composer - 8.9.0.40 by W4 S.A.

leon.app.behaviorinterface
Interface LyLabelBehaviorInterface

All Known Implementing Classes:
LyLabelBehavior

public interface LyLabelBehaviorInterface

Generic interface for all behaviors that need to customize labels.

See Also:
LyAreaController

Field Summary
static java.lang.String __VERSION
          File version
 
Method Summary
 LyInfoLabel getInfoLabel(LyAreaController areaController, LyClassInfo classInfo, LyInfoLabel.Type type)
          Gets info label of the given type for the given class info in the context of the given area controller.
 LyInfoLabel getInfoLabel(LyAreaController areaController, LyFieldInfo fieldInfo, LyInfoLabel.Type type)
          Gets info label of the given type for the given field info in the context of the given area controller.
 java.lang.String getLabel(LyAreaController areaController, LyObject object, LyFieldInfo fieldInfo, java.lang.Object fieldValue)
          Gets the given object label, for the given field info and the given value in the context of the given area controller.
 java.lang.String getName(LyAreaController areaController, LyObject object)
          Gets the name of the object in the context of the given area controller.
 java.lang.String getShortLabel(LyAreaController areaController, LyObject object, LyFieldInfo fieldInfo, java.lang.Object fieldValue)
          Gets the given object short label, for the given field info and the given value in the context of the given area controller.
 

Field Detail

__VERSION

static final java.lang.String __VERSION
File version

See Also:
Constant Field Values
Method Detail

getInfoLabel

LyInfoLabel getInfoLabel(LyAreaController areaController,
                         LyClassInfo classInfo,
                         LyInfoLabel.Type type)
Gets info label of the given type for the given class info in the context of the given area controller.

Parameters:
areaController - the current controller instance
classInfo - the class info
type - Type of searched label. Possible values are LyInfoLabel.Type#GRAMMATICAL, LyInfoLabel.Type#ID, LyInfoLabel.Type#NAME LyInfoLabel.Type#SEMANTIC LyInfoLabel.Type#SHORT_VALUE LyInfoLabel.Type#USER, LyInfoLabel.Type#VALUE
Returns:
The info label if found, null otherwise.

getInfoLabel

LyInfoLabel getInfoLabel(LyAreaController areaController,
                         LyFieldInfo fieldInfo,
                         LyInfoLabel.Type type)
Gets info label of the given type for the given field info in the context of the given area controller.

Parameters:
areaController - the current controller instance
fieldInfo - the field info
type - Type of searched label. Possible values are LyInfoLabel.Type#GRAMMATICAL, LyInfoLabel.Type#ID, LyInfoLabel.Type#NAME LyInfoLabel.Type#SEMANTIC LyInfoLabel.Type#SHORT_VALUE LyInfoLabel.Type#USER, LyInfoLabel.Type#VALUE
Returns:
The info label if found, null otherwise.

getName

java.lang.String getName(LyAreaController areaController,
                         LyObject object)
Gets the name of the object in the context of the given area controller.

Parameters:
areaController - the current controller instance
object - Object whose the name is required.
Returns:
the object name

getLabel

java.lang.String getLabel(LyAreaController areaController,
                          LyObject object,
                          LyFieldInfo fieldInfo,
                          java.lang.Object fieldValue)
Gets the given object label, for the given field info and the given value in the context of the given area controller.
The default implementation does nothing and return null.

Parameters:
areaController - the current controller instance
object - the object for which a label is required.
fieldInfo - field info.
fieldValue - value of the field.
Returns:
the object label as a string.

getShortLabel

java.lang.String getShortLabel(LyAreaController areaController,
                               LyObject object,
                               LyFieldInfo fieldInfo,
                               java.lang.Object fieldValue)
Gets the given object short label, for the given field info and the given value in the context of the given area controller.
The default implementation does nothing and return null.

Parameters:
areaController - the current controller instance
object - Object for which a short label is required.
fieldInfo - field info.
fieldValue - value of the field.
Returns:
the object short label as a string.

(c) January 2013 - W4 S.A.

Website: W4 S.A., contact us: support@w4global.com