LEONARDI Application Composer - 8.9.0.40 by W4 S.A.

leon.view
Class LyChartBase

java.lang.Object
  extended by leon.view.LyComponent
      extended by leon.view.LyFieldItem
          extended by leon.view.LyPanel
              extended by leon.view.LyChartBase
All Implemented Interfaces:
LyGetConstraintInterface, LyGetControllerInterface, LyGetIdInterface, LyPdfInterface, LySetControllerInterface, LySetWaitingInterface, LyUpdateViewContentInterface
Direct Known Subclasses:
LyChart

public abstract class LyChartBase
extends LyPanel
implements LyGetIdInterface, LyGetControllerInterface, LySetControllerInterface, LyGetConstraintInterface

The LyChartBase class is a generated Java implementation that corresponds to the element CHART of the descriptive grammar of the views (views.dtd). <CHART> : Statistic Chart A chart allows displaying a graph representing statistics on data.

See Also:
LyPanel, See also tag CHART of grammar leon_views.dtd.

Nested Class Summary
static class LyChartBase.GraphType
          Possible values for attribute 'graphType'.
static class LyChartBase.Type
          Possible values for attribute 'xType'.
static class LyChartBase.XVal
          Possible values for attribute 'xVal'.
static class LyChartBase.YVal
          Possible values for attribute 'yVal'.
 
Nested classes/interfaces inherited from class leon.view.LyComponent
LyComponent.EventType
 
Field Summary
static java.lang.String __VERSION
           
 
Fields inherited from class leon.view.LyComponent
_nbComponents, INIT_RESOURCE_ID, INTERNAL_ID_SEP, REWRITING_MODE, SEP_ID
 
Constructor Summary
LyChartBase()
          Default constructor.
 
Method Summary
 void addColumn(LyColumn column)
          Adds a sub-component column.
 LyComponent cloneComponent()
          Method for cloning a component.
 LyAxis getAxis()
          Get sub-component Axis.
 LyColumn getColumn(int i)
          Get sub-component Column of index i.
 int getColumnCount()
          Get sub-component Column count.
 LyConstraint getConstraint()
          Get sub-component Constraint.
 java.lang.String getController()
          Gets value of controller.
 LyChartBase.GraphType getGraphType()
          Gets value of graphType.
static LyChartBase.GraphType getGraphType(java.lang.String token)
          Utility method to get graphType value from a string.
 java.lang.String getId()
          Gets value of id.
 LyIntervals getIntervals()
          Get sub-component Intervals.
 LyChart getTemplate()
          Gets value of template.
 java.lang.String getTitle()
          Gets value of title.
static LyChartBase.Type getType(java.lang.String token)
          Utility method to get xType value from a string.
 java.lang.String getXDateType()
          Gets value of xDateType.
 java.lang.String getXFormat()
          Gets value of xFormat.
 java.lang.String getXTitle()
          Gets value of xTitle.
 LyChartBase.Type getXType()
          Gets value of xType.
 LyChartBase.XVal getXVal()
          Gets value of xVal.
static LyChartBase.XVal getXVal(java.lang.String token)
          Utility method to get xVal value from a string.
 java.lang.String getYDateType()
          Gets value of yDateType.
 java.lang.String getYFormat()
          Gets value of yFormat.
 java.lang.String getYTitle()
          Gets value of yTitle.
 LyChartBase.Type getYType()
          Gets value of yType.
 LyChartBase.YVal getYVal()
          Gets value of yVal.
static LyChartBase.YVal getYVal(java.lang.String token)
          Utility method to get yVal value from a string.
 void insertColumn(LyColumn column, int pos)
          Inserts a sub-component column at given position.
 boolean isD3Effect()
          Checks if value of attribute d3Effect is set.
 boolean isDisplayLegendEmptyValues()
          Checks if value of attribute displayLegendEmptyValues is set.
 boolean isNoXField()
          Checks if value of attribute noXField is set.
 boolean isPieBy()
          Checks if value of attribute pieBy is set.
 boolean isRatios()
          Checks if value of attribute ratios is set.
 boolean isShowLegend()
          Checks if value of attribute showLegend is set.
 boolean isShowTips()
          Checks if value of attribute showTips is set.
 boolean isXGrid()
          Checks if value of attribute xGrid is set.
 boolean isXVerticalLabels()
          Checks if value of attribute xVerticalLabels is set.
 boolean isYGrid()
          Checks if value of attribute yGrid is set.
 void removeColumn(LyColumn column)
          Removes a sub-component column.
 void setAxis(LyAxis axis)
          Sets sub-component axis.
 void setConstraint(LyConstraint constraint)
          Sets sub-component constraint.
 void setController(java.lang.String controller)
          Initializes attribute controller to the given value.
 void setD3Effect(boolean d3Effect)
          Initializes attribute d3Effect to the given value.
 void setDisplayLegendEmptyValues(boolean displayLegendEmptyValues)
          Initializes attribute displayLegendEmptyValues to the given value.
 void setGraphType(LyChartBase.GraphType graphType)
          Initializes attribute graphType to the given value.
 void setId(java.lang.String id)
          Initializes attribute id to the given value.
 void setIntervals(LyIntervals intervals)
          Sets sub-component intervals.
 void setNoXField(boolean noXField)
          Initializes attribute noXField to the given value.
 void setPieBy(boolean pieBy)
          Initializes attribute pieBy to the given value.
 void setRatios(boolean ratios)
          Initializes attribute ratios to the given value.
 void setShowLegend(boolean showLegend)
          Initializes attribute showLegend to the given value.
 void setShowTips(boolean showTips)
          Initializes attribute showTips to the given value.
 void setTemplate(LyChart template)
          Initializes attribute template to the given value.
 void setTitle(java.lang.String title)
          Initializes attribute title to the given value.
 void setXDateType(java.lang.String xDateType)
          Initializes attribute xDateType to the given value.
 void setXFormat(java.lang.String xFormat)
          Initializes attribute xFormat to the given value.
 void setXGrid(boolean xGrid)
          Initializes attribute xGrid to the given value.
 void setXTitle(java.lang.String xTitle)
          Initializes attribute xTitle to the given value.
 void setXType(LyChartBase.Type xType)
          Initializes attribute xType to the given value.
 void setXVal(LyChartBase.XVal xVal)
          Initializes attribute xVal to the given value.
 void setXVerticalLabels(boolean xVerticalLabels)
          Initializes attribute xVerticalLabels to the given value.
 void setYDateType(java.lang.String yDateType)
          Initializes attribute yDateType to the given value.
 void setYFormat(java.lang.String yFormat)
          Initializes attribute yFormat to the given value.
 void setYGrid(boolean yGrid)
          Initializes attribute yGrid to the given value.
 void setYTitle(java.lang.String yTitle)
          Initializes attribute yTitle to the given value.
 void setYType(LyChartBase.Type yType)
          Initializes attribute yType to the given value.
 void setYVal(LyChartBase.YVal yVal)
          Initializes attribute yVal to the given value.
 void writeXml(java.io.PrintWriter pw, boolean debug)
          Method to rewrite XML corresponding to this component.
 
Methods inherited from class leon.view.LyPanel
generatePdf, getLastModified, isIdle, isScrollable, print, setIdle, setLastModified, setPopupMenu, setWaiting
 
Methods inherited from class leon.view.LyFieldItem
addBeanData, buildBean, free, getBean, getBeanComponent, getBeanData, getBeanDatas, getChild, getChildCount, getErrorMessage, getFieldValue, getValue, setBean, setBeanComponent, setBeanDatas, setFieldValue, setLabel, updateViewContent, validateInput
 
Methods inherited from class leon.view.LyComponent
addComponent, addData, addEventFunction, clearChildrenBounds, freeze, getBounds, getChildFromCache, getChildrenBounds, getComponent, getComponent, getComponent, getComponent, getComponent, getComponentAt, getComponentAt, getComponentByInternalId, getComponentByLabel, getComponents, getComponentWithModel, getData, getDatas, getEnvironment, getEventFunctions, getIdCode, getInternalId, getInternalView, getInternalView, getLock, getModel, getParent, getParentArea, getParentForm, getParentFormFieldId, getParentSplitter, getParentSplitter, getParentTab, getParentTab, getParentTabs, getParentTabs, getParentView, getRootController, getSetVisibleParent, getTag, getViewManager, isFreed, isFreeing, registerChildrenBounds, removeComponent, reset, resetChildrenCache, resetEventFunctions, setDatas, setInternalView, setVisible, useEventDefaultFunction, writeXml
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

__VERSION

public static final java.lang.String __VERSION
See Also:
Constant Field Values
Constructor Detail

LyChartBase

public LyChartBase()
Default constructor.

Method Detail

getGraphType

public static final LyChartBase.GraphType getGraphType(java.lang.String token)
Utility method to get graphType value from a string.

Parameters:
token - Token string
Returns:
GraphType value corresponding to this token

getXVal

public static final LyChartBase.XVal getXVal(java.lang.String token)
Utility method to get xVal value from a string.

Parameters:
token - Token string
Returns:
XVal value corresponding to this token

getYVal

public static final LyChartBase.YVal getYVal(java.lang.String token)
Utility method to get yVal value from a string.

Parameters:
token - Token string
Returns:
YVal value corresponding to this token

getType

public static final LyChartBase.Type getType(java.lang.String token)
Utility method to get xType value from a string.

Parameters:
token - Token string
Returns:
Type value corresponding to this token

cloneComponent

public LyComponent cloneComponent()
Method for cloning a component.

Specified by:
cloneComponent in class LyComponent

getId

public java.lang.String getId()
Gets value of id.

Specified by:
getId in interface LyGetIdInterface
Overrides:
getId in class LyComponent
Returns:
value of id.

getTemplate

public LyChart getTemplate()
Gets value of template.

Returns:
value of template.

getController

public java.lang.String getController()
Gets value of controller.

Specified by:
getController in interface LyGetControllerInterface
Returns:
value of controller.

getGraphType

public LyChartBase.GraphType getGraphType()
Gets value of graphType.

Returns:
value of graphType.

getXVal

public LyChartBase.XVal getXVal()
Gets value of xVal.

Returns:
value of xVal.

getYVal

public LyChartBase.YVal getYVal()
Gets value of yVal.

Returns:
value of yVal.

isPieBy

public boolean isPieBy()
Checks if value of attribute pieBy is set.

Returns:
true if pieBy is set, false otherwise.

getTitle

public java.lang.String getTitle()
Gets value of title.

Returns:
value of title.

getXTitle

public java.lang.String getXTitle()
Gets value of xTitle.

Returns:
value of xTitle.

getYTitle

public java.lang.String getYTitle()
Gets value of yTitle.

Returns:
value of yTitle.

getXType

public LyChartBase.Type getXType()
Gets value of xType.

Returns:
value of xType.

getYType

public LyChartBase.Type getYType()
Gets value of yType.

Returns:
value of yType.

getXDateType

public java.lang.String getXDateType()
Gets value of xDateType.

Returns:
value of xDateType.

getYDateType

public java.lang.String getYDateType()
Gets value of yDateType.

Returns:
value of yDateType.

getXFormat

public java.lang.String getXFormat()
Gets value of xFormat.

Returns:
value of xFormat.

getYFormat

public java.lang.String getYFormat()
Gets value of yFormat.

Returns:
value of yFormat.

isXVerticalLabels

public boolean isXVerticalLabels()
Checks if value of attribute xVerticalLabels is set.

Returns:
true if xVerticalLabels is set, false otherwise.

isXGrid

public boolean isXGrid()
Checks if value of attribute xGrid is set.

Returns:
true if xGrid is set, false otherwise.

isYGrid

public boolean isYGrid()
Checks if value of attribute yGrid is set.

Returns:
true if yGrid is set, false otherwise.

isD3Effect

public boolean isD3Effect()
Checks if value of attribute d3Effect is set.

Returns:
true if d3Effect is set, false otherwise.

isShowLegend

public boolean isShowLegend()
Checks if value of attribute showLegend is set.

Returns:
true if showLegend is set, false otherwise.

isShowTips

public boolean isShowTips()
Checks if value of attribute showTips is set.

Returns:
true if showTips is set, false otherwise.

isRatios

public boolean isRatios()
Checks if value of attribute ratios is set.

Returns:
true if ratios is set, false otherwise.

isNoXField

public boolean isNoXField()
Checks if value of attribute noXField is set.

Returns:
true if noXField is set, false otherwise.

isDisplayLegendEmptyValues

public boolean isDisplayLegendEmptyValues()
Checks if value of attribute displayLegendEmptyValues is set.

Returns:
true if displayLegendEmptyValues is set, false otherwise.

getColumn

public LyColumn getColumn(int i)
Get sub-component Column of index i.

Parameters:
i - the index of the Column to get.
Returns:
sub-component Column of index i.

getColumnCount

public int getColumnCount()
Get sub-component Column count.

Returns:
sub-component Column count.

getIntervals

public LyIntervals getIntervals()
Get sub-component Intervals.

Returns:
sub-component Intervals.

getAxis

public LyAxis getAxis()
Get sub-component Axis.

Returns:
sub-component Axis.

getConstraint

public LyConstraint getConstraint()
Get sub-component Constraint.

Specified by:
getConstraint in interface LyGetConstraintInterface
Returns:
sub-component Constraint.

setId

public void setId(java.lang.String id)
Initializes attribute id to the given value.

Parameters:
id - New value of id.

setTemplate

public void setTemplate(LyChart template)
Initializes attribute template to the given value.

Parameters:
template - New value of template.

setController

public void setController(java.lang.String controller)
Initializes attribute controller to the given value.

Specified by:
setController in interface LySetControllerInterface
Parameters:
controller - New value of controller.
See Also:
LySetControllerInterface.setController(java.lang.String)

setGraphType

public void setGraphType(LyChartBase.GraphType graphType)
Initializes attribute graphType to the given value.

Parameters:
graphType - New value of graphType.
Throws:
java.lang.IllegalArgumentException - if graphType parameter is null.

setXVal

public void setXVal(LyChartBase.XVal xVal)
Initializes attribute xVal to the given value.

Parameters:
xVal - New value of xVal.
Throws:
java.lang.IllegalArgumentException - if xVal parameter is null.

setYVal

public void setYVal(LyChartBase.YVal yVal)
Initializes attribute yVal to the given value.

Parameters:
yVal - New value of yVal.
Throws:
java.lang.IllegalArgumentException - if yVal parameter is null.

setPieBy

public void setPieBy(boolean pieBy)
Initializes attribute pieBy to the given value.

Parameters:
pieBy - Boolean indicating if attribute pieBy is set or unset.

setTitle

public void setTitle(java.lang.String title)
Initializes attribute title to the given value.

Parameters:
title - New value of title.

setXTitle

public void setXTitle(java.lang.String xTitle)
Initializes attribute xTitle to the given value.

Parameters:
xTitle - New value of xTitle.

setYTitle

public void setYTitle(java.lang.String yTitle)
Initializes attribute yTitle to the given value.

Parameters:
yTitle - New value of yTitle.

setXType

public void setXType(LyChartBase.Type xType)
Initializes attribute xType to the given value.

Parameters:
xType - New value of xType.
Throws:
java.lang.IllegalArgumentException - if xType parameter is null.

setYType

public void setYType(LyChartBase.Type yType)
Initializes attribute yType to the given value.

Parameters:
yType - New value of yType.
Throws:
java.lang.IllegalArgumentException - if yType parameter is null.

setXDateType

public void setXDateType(java.lang.String xDateType)
Initializes attribute xDateType to the given value.

Parameters:
xDateType - New value of xDateType.

setYDateType

public void setYDateType(java.lang.String yDateType)
Initializes attribute yDateType to the given value.

Parameters:
yDateType - New value of yDateType.

setXFormat

public void setXFormat(java.lang.String xFormat)
Initializes attribute xFormat to the given value.

Parameters:
xFormat - New value of xFormat.

setYFormat

public void setYFormat(java.lang.String yFormat)
Initializes attribute yFormat to the given value.

Parameters:
yFormat - New value of yFormat.

setXVerticalLabels

public void setXVerticalLabels(boolean xVerticalLabels)
Initializes attribute xVerticalLabels to the given value.

Parameters:
xVerticalLabels - Boolean indicating if attribute xVerticalLabels is set or unset.

setXGrid

public void setXGrid(boolean xGrid)
Initializes attribute xGrid to the given value.

Parameters:
xGrid - Boolean indicating if attribute xGrid is set or unset.

setYGrid

public void setYGrid(boolean yGrid)
Initializes attribute yGrid to the given value.

Parameters:
yGrid - Boolean indicating if attribute yGrid is set or unset.

setD3Effect

public void setD3Effect(boolean d3Effect)
Initializes attribute d3Effect to the given value.

Parameters:
d3Effect - Boolean indicating if attribute d3Effect is set or unset.

setShowLegend

public void setShowLegend(boolean showLegend)
Initializes attribute showLegend to the given value.

Parameters:
showLegend - Boolean indicating if attribute showLegend is set or unset.

setShowTips

public void setShowTips(boolean showTips)
Initializes attribute showTips to the given value.

Parameters:
showTips - Boolean indicating if attribute showTips is set or unset.

setRatios

public void setRatios(boolean ratios)
Initializes attribute ratios to the given value.

Parameters:
ratios - Boolean indicating if attribute ratios is set or unset.

setNoXField

public void setNoXField(boolean noXField)
Initializes attribute noXField to the given value.

Parameters:
noXField - Boolean indicating if attribute noXField is set or unset.

setDisplayLegendEmptyValues

public void setDisplayLegendEmptyValues(boolean displayLegendEmptyValues)
Initializes attribute displayLegendEmptyValues to the given value.

Parameters:
displayLegendEmptyValues - Boolean indicating if attribute displayLegendEmptyValues is set or unset.

addColumn

public void addColumn(LyColumn column)
Adds a sub-component column.

Parameters:
column - The column to add to columns list.

insertColumn

public void insertColumn(LyColumn column,
                         int pos)
Inserts a sub-component column at given position.

Parameters:
column - The column to add to columns list.
pos - Position where the sub-component is inserted.

removeColumn

public void removeColumn(LyColumn column)
Removes a sub-component column.

Parameters:
column - The column to remove to columns list.
Throws:
java.lang.IllegalStateException - if columns list is empty.
java.lang.IllegalArgumentException - if columns list doesn't contain column.

setIntervals

public void setIntervals(LyIntervals intervals)
Sets sub-component intervals.

Parameters:
intervals - New value of intervals

setAxis

public void setAxis(LyAxis axis)
Sets sub-component axis.

Parameters:
axis - New value of axis

setConstraint

public void setConstraint(LyConstraint constraint)
Sets sub-component constraint.

Parameters:
constraint - New value of constraint

writeXml

public void writeXml(java.io.PrintWriter pw,
                     boolean debug)
Method to rewrite XML corresponding to this component.

Specified by:
writeXml in class LyComponent
Parameters:
pw - the printWriter on which the XML is written.
debug - true if debug mode (full dump).

(c) January 2013 - W4 S.A.

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