LEONARDI Application Composer - 8.9.0.40 by W4 S.A.

leon.app.behaviorinterface
Interface LyChartBehaviorInterface

All Superinterfaces:
LyActionBehaviorInterface, LyBehaviorInterface, LyFormBehaviorInterface
All Known Implementing Classes:
LyChartBehavior, LyMetricsChartBehavior

public interface LyChartBehaviorInterface
extends LyFormBehaviorInterface

This interface defines the methods to implement in order to modify the behavior of a chart action.

See Also:
LyChartController, LyGraphicalChartController

Field Summary
static java.lang.String __VERSION
          File version
 
Method Summary
 void completeChart(LyGraphicalChartController controller, LyChart chart)
          Complete chart component before showing it.
 boolean displayLegendEmptyValues(LyGraphicalChartController controller)
          Indicates whether empty values must be displayed on the legend.
 boolean generateSensitiveAreas(LyGraphicalChartController controller)
          Indicates whether sensitive areas must be generated or not.
 java.lang.String getBarLegendLabel(LyGraphicalChartController controller, LyFieldInfo fieldInfo, LyObject object, java.lang.Object value)
          Gets the label that must be shown in the legend of a bar chart.
 LyObjectList getChartContext(LyController controller, LySession session, LyClassInfo classInfo, LyObjectList objects, LyWorkSpace parentContext)
          Gets the chart context objects list.
 LyInfoList<LyFieldInfo> getGroupFields(LyChartController controller)
          Gets fields that may be used as group variables in the chart.
 java.lang.String getScatterPlotLabel(LyGraphicalChartController controller, LyObject object)
          Gets the label that must be used for a point on a scatter plot chart.
 java.lang.String getScatterPlotLegendLabel(LyGraphicalChartController controller, LyObject object)
          Returns the label that must be used for a point on a scatter plot legend.
 java.lang.Object getStringChartValue(LyGraphicalChartController controller, LyFieldInfo fieldInfo, LyObject object, java.lang.Object value, LyChartInfo.Type typeVar, boolean yAxis)
          Computes a printable string (if the given typeVar is text, number or date) or a Vector of strings (if the given fieldInfo is a multiple choice or relation) from the given value.
 LyInfoList<LyFieldInfo> getXFields(LyChartController controller)
          Gets fields that may be used as X variables in the chart.
 LyInfoList<LyFieldInfo> getYFields(LyChartController controller)
          Gets fields that may be used as Y variables in the chart.
 boolean isLegendRightPositionned(LyGraphicalChartController controller)
          Indicates if the legend must be positionned on the right of the chart.
 boolean isViewResizable(LyController controller)
          Indicates whether a graphical chart view is resizable or not.
 
Methods inherited from interface leon.app.behaviorinterface.LyFormBehaviorInterface
getImage, getValue, isDisplayed
 
Methods inherited from interface leon.app.behaviorinterface.LyActionBehaviorInterface
endAction, getClientContext, getContextTitle, getHelpFile, getImage, getImageTooltip, getKeyValue, getMenuItemImage, getTitle, reset, startAction
 
Methods inherited from interface leon.app.behaviorinterface.LyBehaviorInterface
free, handleDemand, init
 

Field Detail

__VERSION

static final java.lang.String __VERSION
File version

See Also:
Constant Field Values
Method Detail

isViewResizable

boolean isViewResizable(LyController controller)
Indicates whether a graphical chart view is resizable or not.

Parameters:
controller - the current chart controller or graphical chart controller
Returns:
true if the view is resizable, false otherwise

getXFields

LyInfoList<LyFieldInfo> getXFields(LyChartController controller)
Gets fields that may be used as X variables in the chart.

Parameters:
controller - The current chart controller.
Returns:
the fields that may be used as X variables.

getYFields

LyInfoList<LyFieldInfo> getYFields(LyChartController controller)
Gets fields that may be used as Y variables in the chart.

Parameters:
controller - The current chart controller.
Returns:
the fields that may be used as Y variables.

getGroupFields

LyInfoList<LyFieldInfo> getGroupFields(LyChartController controller)
Gets fields that may be used as group variables in the chart.

Parameters:
controller - The current chart controller.
Returns:
the fields that may be used as group variables.

getChartContext

LyObjectList getChartContext(LyController controller,
                             LySession session,
                             LyClassInfo classInfo,
                             LyObjectList objects,
                             LyWorkSpace parentContext)
Gets the chart context objects list.

Parameters:
controller - the controller
session - the current session
classInfo - the classInfo that contains values
objects - the selected objects of the current class
parentContext - the context of the parent class
Returns:
the context for the chart

getStringChartValue

java.lang.Object getStringChartValue(LyGraphicalChartController controller,
                                     LyFieldInfo fieldInfo,
                                     LyObject object,
                                     java.lang.Object value,
                                     LyChartInfo.Type typeVar,
                                     boolean yAxis)
Computes a printable string (if the given typeVar is text, number or date) or a Vector of strings (if the given fieldInfo is a multiple choice or relation) from the given value. This (these) string(s) will be inserted in LyChart.

Parameters:
controller - the current controller instance
fieldInfo - the field info concerned
object - the object concerned (may be null)
value - the value to transform into string. It comes from the fieldInfo
typeVar - the type of the field, like date or numeric (defined in LyChartInfo)
yAxis - indicates whether the value is computed for y or x axis
Returns:
a String corresponding to the value, or a Vector of Strings if it is a multiple choice or relation.
See Also:
LyChartInfo

getBarLegendLabel

java.lang.String getBarLegendLabel(LyGraphicalChartController controller,
                                   LyFieldInfo fieldInfo,
                                   LyObject object,
                                   java.lang.Object value)
Gets the label that must be shown in the legend of a bar chart.

Parameters:
controller - the current controller instance
fieldInfo - the field info concerned
object - the object concerned (may be null)
value - the value to transform into string. It comes from the fieldInfo
Returns:
null if default label must be used, a string value otherwise

getScatterPlotLabel

java.lang.String getScatterPlotLabel(LyGraphicalChartController controller,
                                     LyObject object)
Gets the label that must be used for a point on a scatter plot chart.

Parameters:
controller - the current controller instance
object - the object concerned
Returns:
the label that must be used for a given point

getScatterPlotLegendLabel

java.lang.String getScatterPlotLegendLabel(LyGraphicalChartController controller,
                                           LyObject object)
Returns the label that must be used for a point on a scatter plot legend.

Parameters:
controller - the current controller instance
object - the object concerned
Returns:
the label that must be used for a given point

isLegendRightPositionned

boolean isLegendRightPositionned(LyGraphicalChartController controller)
Indicates if the legend must be positionned on the right of the chart.

Parameters:
controller - the current controller instance
Returns:
true if the legend must be positionned on the right of the chart, false otherwise

displayLegendEmptyValues

boolean displayLegendEmptyValues(LyGraphicalChartController controller)
Indicates whether empty values must be displayed on the legend.

Parameters:
controller - the current controller instance
Returns:
true if empty values must be displayed on the legend, false otherwise

generateSensitiveAreas

boolean generateSensitiveAreas(LyGraphicalChartController controller)
Indicates whether sensitive areas must be generated or not.

Parameters:
controller - the current controller instance
Returns:
true if sensitive areas must be generated on the chart, false otherwise

completeChart

void completeChart(LyGraphicalChartController controller,
                   LyChart chart)
Complete chart component before showing it.

Parameters:
controller - the current controller instance
chart - the chart component

(c) January 2013 - W4 S.A.

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