|
LEONARDI Application Composer - 8.9.0.40 by W4 S.A. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectleon.info.LyTag
leon.info.LyInfo
leon.info.LyObjectInfo
leon.info.LyChartInfo
public class LyChartInfo
The LyChartInfo class implements the description of a chart applied on objects of the application.
LyChartController
Nested Class Summary | |
---|---|
static class |
LyChartInfo.GraphType
|
static class |
LyChartInfo.Type
|
static class |
LyChartInfo.ValType
|
Nested classes/interfaces inherited from class leon.info.LyTag |
---|
LyTag.Model |
Field Summary | |
---|---|
static java.lang.String |
__version
|
Fields inherited from class leon.info.LyObjectInfo |
---|
__VERSION, NULL, PART_ALL, PART_BIND, PART_DATA, PART_GUI, PART_LABEL |
Fields inherited from interface leon.info.LyGetClassInfoInterface |
---|
__VERSION |
Fields inherited from interface leon.info.infointerface.LyExtraInfoInterface |
---|
__VERSION |
Constructor Summary | |
---|---|
LyChartInfo()
Public constructor. |
|
LyChartInfo(java.lang.String id,
java.lang.String name,
LyChartInfo template)
Constructor. |
|
LyChartInfo(java.lang.String id,
java.lang.String name,
java.lang.String classInfoId,
java.lang.String selectedXFieldInfo,
java.lang.String selectedGroupFieldInfo,
LyChartInfo.Type typeVarY,
LyChartInfo.Type typeVarX,
LyChartInfo.GraphType selectedGraphType,
LyChartInfo.ValType xVal,
java.lang.String[] xIntervals,
LyChartInfo.ValType yVal,
java.lang.String[] yIntervals,
boolean pieBy,
java.lang.String title,
java.lang.String xTitle,
java.lang.String yTitle,
java.lang.String[] xAxis,
java.lang.String[] yAxis,
boolean xVerticalLabels,
boolean xGrid,
boolean yGrid,
boolean d3Effect,
boolean showLegend,
boolean showTips,
boolean ratios)
Constructor. |
Method Summary | |
---|---|
void |
addYField(java.lang.String yField)
Add an element in Y fields id vector. |
LyChartInfo |
cloneChartInfo(java.lang.String id)
Duplicate all the attributes of a LyChartInfo. |
boolean |
deleteFile()
Method for deleting preference file. |
void |
free()
Method for freeing extra info (and sub-infos). |
boolean |
get3dEffect()
Accessor to 3D Effect : enabled if true, disabled if false. |
LyClassInfo |
getClassInfo()
Gets the ClassInfo of current controller. |
java.lang.String |
getClassInfoId()
Accessor to the Id of the LyClassInfo. |
LyInfoList<LyFieldInfo> |
getFields()
Gets all fields that this chart info needs to be drawed. |
java.lang.String |
getImage()
Method for retrieving the name of the image associated to the type of chart. |
boolean |
getPieBy()
Accessor to the type of the pies, if there are any. |
LyPreference |
getPreference()
Accessor to the preference of this chart. |
boolean |
getRatios()
Accessor to ratios : ratios if true, real values if false. |
LyChartInfo.GraphType |
getSelectedGraphType()
Accessor to the graphic type of the chart. |
java.lang.String |
getSelectedGroupFieldInfo()
Accessor to the group field of the chart. |
java.lang.String |
getSelectedXFieldInfo()
Accessor to the X field of the chart. |
java.util.Vector<java.lang.String> |
getSelectedYFieldsInfo()
Accessor to the Y fields of the chart. |
boolean |
getShowLegend()
Accessor to legend : show if true, hide if false. |
boolean |
getShowTips()
Accessor to label tips : show if true, hide (or show only when the mouse is over the point) if false. |
java.lang.String |
getTitle()
Accessor to the title of the chart graphic. |
LyChartInfo.Type |
getTypeVarX()
Accessor to the x type of variable. |
LyChartInfo.Type |
getTypeVarY()
Accessor to the y type of variables. |
java.lang.String |
getUser()
Get owner of this chart. |
java.lang.String[] |
getXAxis()
Accessor to the vector of 3 values for the X axis. |
java.lang.String |
getXAxisMax()
Accessor to the value for the X axis max. |
java.lang.String |
getXAxisMin()
Accessor to the value for the X axis min. |
java.lang.String |
getXAxisWidth()
Accessor to the value for the X axis width. |
boolean |
getXGrid()
Accessor to X Grid : enabled if true, disabled if false. |
java.lang.String |
getXIntervalBegin()
Accessor to the x interval begin. |
java.lang.String |
getXIntervalLength()
Accessor to the x interval length. |
java.lang.String[] |
getXIntervals()
Accessor to the x intervals of the chart. |
java.lang.String |
getXIntervalUnit()
Accessor to the x interval unit. |
java.lang.String |
getXTitle()
Accessor to the title of X axis. |
LyChartInfo.ValType |
getXVal()
Accessor to the x type of values of the chart (real, intervals). |
boolean |
getXVerticalLabels()
Accessor to the type of X labels : vertical if true, horizontal if false. |
java.lang.String[] |
getYAxis()
Accessor to the vector of 3 values for the Y axis. |
java.lang.String |
getYAxisMax()
Accessor to the value for the X axis max. |
java.lang.String |
getYAxisMin()
Accessor to the value for the Y axis min. |
java.lang.String |
getYAxisWidth()
Accessor to the value for the X axis width. |
boolean |
getYGrid()
Accessor to Y Grid : enabled if true, disabled if false. |
java.lang.String |
getYIntervalBegin()
Accessor to the y interval begin. |
java.lang.String |
getYIntervalLength()
Accessor to the y interval length. |
java.lang.String[] |
getYIntervals()
Accessor to the y intervals of the chart. |
java.lang.String |
getYIntervalUnit()
Accessor to the y interval unit. |
java.lang.String |
getYTitle()
Accessor to the title of Y axis. |
LyChartInfo.ValType |
getYVal()
Accessor to the y type of values of the chart (real, sum or count by interval). |
boolean |
saveFile(LyXmlWriterInterface writer)
Method for saving preference file. |
void |
set3dEffect(boolean d3Effect)
Sets 3D Effect : enabled if true, disabled if false. |
void |
setClassInfoId(java.lang.String classInfoId)
Sets the classInfo of the chart. |
void |
setId(java.lang.String id)
Sets the id of the instance. |
void |
setName(java.lang.String name)
Sets the name of the instance. |
void |
setPieBy(boolean pieBy)
Sets the type of the pies, if there are any. |
void |
setPreference(LyPreference preference)
Sets the preference. |
void |
setRatios(boolean ratios)
Sets the ratios : ratios if true, real values if false. |
void |
setSelectedGraphType(LyChartInfo.GraphType selectedGraphType)
Sets the graphic type of the chart. |
void |
setSelectedGroupFieldInfo(java.lang.String selectedGroupFieldInfo)
Sets the group field of the chart. |
void |
setSelectedXFieldInfo(java.lang.String selectedXFieldInfo)
Sets the X field of the chart. |
void |
setSelectedYFieldsInfo(java.util.Vector<java.lang.String> selectedYFieldsInfo)
Sets the Y fields of the chart. |
void |
setShowLegend(boolean showLegend)
Sets the legend : show if true, hide if false. |
void |
setShowTips(boolean showTips)
Sets the label tips : show if true, hide if false. |
void |
setTitle(java.lang.String title)
Sets the title of the chart graphic. |
void |
setTypeVarX(LyChartInfo.Type typeVarX)
Sets the description of the type of x variable. |
void |
setTypeVarY(LyChartInfo.Type typeVarY)
Sets the description of the type of y variables. |
void |
setXAxis(java.lang.String[] xAxis)
Sets the vector of 3 values for the X axis. |
void |
setXAxisMax(java.lang.String xAxisMax)
Sets the value for the X axis max. |
void |
setXAxisMin(java.lang.String xAxisMin)
Sets the value for the X axis min. |
void |
setXAxisWidth(java.lang.String xAxixWidth)
Sets the value for the X axis width. |
void |
setXGrid(boolean xGrid)
Sets X Grid : enabled if true, disabled if false. |
void |
setXIntervalBegin(java.lang.String xIntervalBegin)
Sets the x interval begin. |
void |
setXIntervalLength(java.lang.String xIntervalLength)
Sets the x interval length. |
void |
setXIntervals(java.lang.String[] xIntervals)
Sets the X intervals of the chart. |
void |
setXIntervalUnit(java.lang.String xIntervalUnit)
Sets the x interval unit. |
void |
setXTitle(java.lang.String xTitle)
Sets the title of X axis. |
void |
setXVal(LyChartInfo.ValType xVal)
Sets the x type of values of the chart (real, intervals). |
void |
setXVerticalLabels(boolean xVerticalLabels)
Sets the type of X labels : vertical if true, horizontal if false. |
void |
setYAxis(java.lang.String[] yAxis)
Sets the vector of 3 values for the Y axis. |
void |
setYAxisMax(java.lang.String yAxisMax)
Sets the value for the Y axis max. |
void |
setYAxisMin(java.lang.String yAxisMin)
Sets the value for the Y axis min. |
void |
setYAxisWidth(java.lang.String yAxixWidth)
Sets the value for the Y axis width. |
void |
setYGrid(boolean yGrid)
Sets Y Grid : enabled if true, disabled if false. |
void |
setYIntervalBegin(java.lang.String yIntervalBegin)
Sets the y interval begin. |
void |
setYIntervalLength(java.lang.String yIntervalLength)
Sets the y interval length. |
void |
setYIntervals(java.lang.String[] yIntervals)
Sets the Y intervals of the chart. |
void |
setYIntervalUnit(java.lang.String yIntervalUnit)
Sets the y interval unit. |
void |
setYTitle(java.lang.String yTitle)
Sets the title of Y axis. |
void |
setYVal(LyChartInfo.ValType yVal)
Sets the y type of values of the chart (real, sum or count by interval). |
java.lang.String |
toString2()
Make a string representing the object. |
void |
writeXml(java.io.PrintWriter pw)
Method to rewrite XML corresponding to this component. |
void |
writeXml(java.io.PrintWriter pw,
boolean header,
boolean body)
Method to rewrite XML corresponding to this component. |
Methods inherited from class leon.info.LyObjectInfo |
---|
clone, getAlias, getData, getDataList, getDatas, getFilePrefix, getGroup, getInternalAlias, getInternalFilePrefix, getInternalName, getMarks, getName, getTemplate, getTip, getUserData, hasMark, hasMarks, hasTemplate, isTemplate, putData, putData, removeData, toName |
Methods inherited from class leon.info.LyInfo |
---|
getApplication, getFile, getId, getInclude, isIncluded, isInternal, isInternal, isLoaded, isLocked, load, setApplication, setFile, toString |
Methods inherited from class leon.info.LyTag |
---|
getCommentsEnd, getCommentsStart, getEnvironment, getModelType, getParent, getRootProject, hasAncestor, isExtern, setCommentsEnd, setCommentsStart, wasCloned |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface leon.info.infointerface.LyExtraInfoInterface |
---|
getFile, setFile |
Methods inherited from interface leon.parser.LyCommentInterface |
---|
getCommentsEnd, getCommentsStart, setCommentsEnd, setCommentsStart |
Field Detail |
---|
public static final java.lang.String __version
Constructor Detail |
---|
public LyChartInfo(java.lang.String id, java.lang.String name, LyChartInfo template)
id
- The identifier of the object. May not be null.template
- Template used to construct this field.public LyChartInfo()
public LyChartInfo(java.lang.String id, java.lang.String name, java.lang.String classInfoId, java.lang.String selectedXFieldInfo, java.lang.String selectedGroupFieldInfo, LyChartInfo.Type typeVarY, LyChartInfo.Type typeVarX, LyChartInfo.GraphType selectedGraphType, LyChartInfo.ValType xVal, java.lang.String[] xIntervals, LyChartInfo.ValType yVal, java.lang.String[] yIntervals, boolean pieBy, java.lang.String title, java.lang.String xTitle, java.lang.String yTitle, java.lang.String[] xAxis, java.lang.String[] yAxis, boolean xVerticalLabels, boolean xGrid, boolean yGrid, boolean d3Effect, boolean showLegend, boolean showTips, boolean ratios)
name
- Name of the Chart.classInfoId
- The Id of the LyClassInfo of the chart. Used only to save/load
charts.selectedYFieldsInfo
- List of fields to analyse (Y). Elements are LyFieldInfo.selectedXFieldInfo
- The field id on X axe (it can be null).selectedGroupFieldInfo
- The field id for group (it can be null).typeVarY
- Type of Y fields.typeVarX
- Type of X field.selectedGraphType
- Graphic typexVal
- type of values for X (real, intervals).xIntervals
- values for the X intervals. Elements are the beginning, the
width and an eventual time unity of interval.yVal
- type of values for Y (real, count or sum by interval).yIntervals
- values for the Y intervals. Elements are the beginning, the
width and an eventual time unity of interval.pieBy
- True if there is one pie by Y var, False if there is one pie by
X value or intervaltitle
- the title of the chart graphic.xTitle
- the title of X axis.yTitle
- the title of Y axis.xAxis
- A vector of 3 values for the X axis. Pos0: min, pos1: max and
pos2: distance between graduations.yAxis
- A vector of 3 values for the Y axis. Pos0: min, pos1: max and
pos2: distance between graduations.xVerticalLabels
- used if the graphic type is not Pie,xGrid
- used to show X Grid if the graphic type is not Pie,yGrid
- used to show Y Grid if the graphic type is not Pie,3dEffect
- used to enable 3D Effect,Method Detail |
---|
public LyChartInfo cloneChartInfo(java.lang.String id)
id
- the identifier of the new LyChartInfo
public java.lang.String getClassInfoId()
public java.util.Vector<java.lang.String> getSelectedYFieldsInfo()
public java.lang.String getSelectedXFieldInfo()
public java.lang.String getSelectedGroupFieldInfo()
public LyChartInfo.Type getTypeVarY()
public LyChartInfo.Type getTypeVarX()
public LyChartInfo.GraphType getSelectedGraphType()
public LyChartInfo.ValType getXVal()
public LyChartInfo.ValType getYVal()
public java.lang.String[] getXIntervals()
public java.lang.String getXIntervalBegin()
public java.lang.String getXIntervalLength()
public java.lang.String getXIntervalUnit()
public java.lang.String[] getYIntervals()
public java.lang.String getYIntervalBegin()
public java.lang.String getYIntervalLength()
public java.lang.String getYIntervalUnit()
public boolean getPieBy()
public java.lang.String getTitle()
public java.lang.String getXTitle()
public java.lang.String getYTitle()
public java.lang.String[] getXAxis()
public java.lang.String getXAxisMin()
public java.lang.String getXAxisMax()
public java.lang.String getXAxisWidth()
public java.lang.String getYAxisMin()
public java.lang.String getYAxisMax()
public java.lang.String getYAxisWidth()
public java.lang.String[] getYAxis()
public boolean getXVerticalLabels()
public boolean getXGrid()
public boolean getYGrid()
public boolean get3dEffect()
public boolean getShowLegend()
public boolean getShowTips()
public boolean getRatios()
public LyPreference getPreference()
public LyClassInfo getClassInfo()
getClassInfo
in interface LyGetClassInfoInterface
public java.lang.String getImage()
public void setId(java.lang.String id)
id
- Identifier of the instance.public void setName(java.lang.String name)
name
- Name of the instance.public void setClassInfoId(java.lang.String classInfoId)
classInfoId
- the classInfo of the chart.public void setSelectedYFieldsInfo(java.util.Vector<java.lang.String> selectedYFieldsInfo)
selectedYFieldsInfo
- the Y fields of the chart.public void setSelectedXFieldInfo(java.lang.String selectedXFieldInfo)
selectedXFieldInfo
- the X field of the chart.public void setSelectedGroupFieldInfo(java.lang.String selectedGroupFieldInfo)
selectedGroupFieldInfo
- the group field of the chart.public void setTypeVarY(LyChartInfo.Type typeVarY)
typeVarY
- the description of the type of y variables.public void setTypeVarX(LyChartInfo.Type typeVarX)
typeVarX
- the description of the type of x variable.public void setSelectedGraphType(LyChartInfo.GraphType selectedGraphType)
selectedGraphType
- the graphic type of the chart.public void setXVal(LyChartInfo.ValType xVal)
xVal
- the x type of values of the chart (real, intervals).public void setYVal(LyChartInfo.ValType yVal)
yVal
- the y type of values of the chart (real, sum or count by interval).public void setXIntervalBegin(java.lang.String xIntervalBegin)
public void setXIntervalLength(java.lang.String xIntervalLength)
public void setXIntervalUnit(java.lang.String xIntervalUnit)
public void setXIntervals(java.lang.String[] xIntervals)
xIntervals
- the X intervals of the chart.public void setYIntervalBegin(java.lang.String yIntervalBegin)
public void setYIntervalLength(java.lang.String yIntervalLength)
public void setYIntervalUnit(java.lang.String yIntervalUnit)
public void setYIntervals(java.lang.String[] yIntervals)
yIntervals
- the Y intervals of the chart.public void setPieBy(boolean pieBy)
pieBy
- the type of the pies, if there are any.public void setTitle(java.lang.String title)
title
- the title of the chart graphic.public void setXTitle(java.lang.String xTitle)
xTitle
- the title of X axis.public void setYTitle(java.lang.String yTitle)
yTitle
- the title of Y axis.public void setYAxisMin(java.lang.String yAxisMin)
public void setYAxisMax(java.lang.String yAxisMax)
public void setYAxisWidth(java.lang.String yAxixWidth)
public void setXAxisMin(java.lang.String xAxisMin)
public void setXAxisMax(java.lang.String xAxisMax)
public void setXAxisWidth(java.lang.String xAxixWidth)
public void setXAxis(java.lang.String[] xAxis)
xAxis
- the vector of 3 values for the X axis.public void setYAxis(java.lang.String[] yAxis)
yAxis
- the vector of 3 values for the Y axis.public void setXVerticalLabels(boolean xVerticalLabels)
xVerticalLabels
- vertical if true, horizontal if false.public void setXGrid(boolean xGrid)
xGrid
- enabled if true, disabled if false.public void setYGrid(boolean yGrid)
yGrid
- enabled if true, disabled if false.public void set3dEffect(boolean d3Effect)
d3Effect
- enabled if true, disabled if false.public void setShowLegend(boolean showLegend)
showLegend
- show if true, hide if false.public void setShowTips(boolean showTips)
showTips
- show if true, hide if false.public void setRatios(boolean ratios)
ratios
- ratios if true, real values if false.public void setPreference(LyPreference preference)
the
- preference of this chartpublic void addYField(java.lang.String yField)
yField
- an element in Y fields id vector.public LyInfoList<LyFieldInfo> getFields()
public java.lang.String toString2()
public java.lang.String getUser()
getUser
in interface LyExtraInfoInterface
public boolean saveFile(LyXmlWriterInterface writer)
saveFile
in interface LyExtraInfoInterface
public void free()
free
in interface LyExtraInfoInterface
public boolean deleteFile()
deleteFile
in interface LyExtraInfoInterface
public void writeXml(java.io.PrintWriter pw, boolean header, boolean body)
writeXml
in interface LyExtraInfoInterface
pw
- The printWriter on which the XML is written.header
- Boolean indicating if header must be written.header
- Boolean indicating if body must be written.public void writeXml(java.io.PrintWriter pw)
writeXml
in interface LyExtraInfoInterface
pw
- the printWriter on which the XML is written.
|
(c) January 2013 - W4 S.A. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |