|
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.LyTreemapConfiguration
public final class LyTreemapConfiguration
This class represents a treemap configuration. It contains all the parameters that may be defined by the user.
LyObjectInfo
,
LyFilter
Nested Class Summary | |
---|---|
static class |
LyTreemapConfiguration.Aggregation
Algorithms for aggregation. |
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 |
---|
NULL, PART_ALL, PART_BIND, PART_DATA, PART_GUI, PART_LABEL |
Constructor Summary | |
---|---|
LyTreemapConfiguration(java.lang.String id,
LyObjectInfo objectInfo,
java.lang.String name,
int hierarchyLevels,
LyTreemapConfiguration.Aggregation aggregationType,
boolean filterActive,
boolean filterShowAll,
java.lang.String minColor,
java.lang.String maxColor,
java.lang.String[] thresholdColors,
java.lang.String borderSizes,
java.lang.String labelStyles,
java.lang.String user)
Constructor for a treemap configuration. |
Method Summary | |
---|---|
LyTreemapConfiguration |
cloneTreemapConfiguration()
Clone a treemap configuration. |
boolean |
deleteFile()
Method for deleting preference file. |
void |
free()
Method for freeing extra info (and sub-infos). |
LyFieldInfo |
getAggregationFieldInfo()
Get the field info used to compute aggregations in this treemap configuration. |
LyTreemapConfiguration.Aggregation |
getAggregationType()
Get the aggregation type. |
java.lang.String |
getBorderSizes()
Get border sizes of this treemap configuration. |
LyFieldInfo |
getColorFieldInfo()
Get the field info used to compute the color of this treemap configuration. |
LyFilter |
getFilter()
Get filter used by this treemap configuration. |
LyInfoList<LyFieldInfo> |
getHierarchyFieldInfos()
Gets list of field infos of this treemap configuration. |
int |
getHierarchyLevels()
Return the hierarchy levels for this treemap configuration. |
java.lang.String |
getLabelStyles()
Get label styles of this treemap configuration. |
java.lang.String |
getMaxColor()
Get maximum color of this treemap configuration. |
java.lang.String |
getMinColor()
Get minimum color of this treemap configuration. |
LyObjectInfo |
getObjectInfo()
Get object info referred by this treemap configuration. |
LyFieldInfo |
getSizeFieldInfo()
Get the field info used to compute the size of this treemap configuration. |
java.lang.String[] |
getThresholdColors()
Get the list of threshold colors of this treemap configuration. |
java.lang.String |
getUser()
Get owner of this treemap configuration. |
boolean |
isFilterActive()
Indicates whether filter is active or not in this treemap configuration. |
boolean |
isFilterShowAll()
Indicates whether filter shows all object or not in this treemap configuration. |
boolean |
saveFile(LyXmlWriterInterface writer)
Method for saving preference file. |
void |
setAggregationFieldInfo(LyFieldInfo aggregationField)
Set the field info used to compute aggregations. |
void |
setAggregationType(LyTreemapConfiguration.Aggregation aggregationType)
Set the aggregation type. |
void |
setBorderSizes(java.lang.String borderSizes)
Set the border sizes. |
void |
setColorFieldInfo(LyFieldInfo colorField)
Set the field info used to compute the colors. |
void |
setFilter(LyFilter filter)
Sets the filter used by this treemap configuration. |
void |
setFilterActive(boolean active)
Set the activated state for filter. |
void |
setFilterShowAll(boolean showAll)
Set the show all state for filter. |
void |
setHierarchyFieldInfos(LyInfoList<LyFieldInfo> fieldInfos)
Sets list of hierarchy field infos of this treemap configuration. |
void |
setHierarchyLevels(int hierarchyLevels)
Set the hierarchy levels. |
void |
setLabelStyles(java.lang.String labelStyles)
Set the label styles. |
void |
setMaxColor(java.lang.String maxColor)
Set the maximum color. |
void |
setMinColor(java.lang.String minColor)
Set the minimum color. |
void |
setSizeFieldInfo(LyFieldInfo sizeField)
Set the field info used to compute the sizes. |
void |
setThresholdColors(java.lang.String[] colors)
Set the list of threshold colors. |
void |
writeXml(java.io.PrintWriter pw)
Writes XML corresponding to this filter element. |
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 LyTreemapConfiguration(java.lang.String id, LyObjectInfo objectInfo, java.lang.String name, int hierarchyLevels, LyTreemapConfiguration.Aggregation aggregationType, boolean filterActive, boolean filterShowAll, java.lang.String minColor, java.lang.String maxColor, java.lang.String[] thresholdColors, java.lang.String borderSizes, java.lang.String labelStyles, java.lang.String user)
id
- the identifier of the treemap configuration.objectInfo
- The concerned object info.name
- the name of the treemap configuration.hierarchyLevels
- hierarchy levels of the treemap configuration.aggregationType
- aggregation type of the treemap configuration.filterActive
- indicates if filter is active in the treemap configuration.filterShowAll
- indicates if filter shows all the objects in the treemap
configuration.minColor
- min color of the treemap configuration.maxColor
- max color of the treemap configuration.thresholdColors
- list of threshold colors of the treemap configuration.borderSizes
- sizes of the borders of the treemap configuration.labelStyles
- styles of the labels of the treemap configuration.user
- the id of the user that owns the treemap configuration.Method Detail |
---|
public LyTreemapConfiguration cloneTreemapConfiguration()
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
- PrintWriter on which the XML is written.public LyObjectInfo getObjectInfo()
public LyFilter getFilter()
public LyFieldInfo getSizeFieldInfo()
public LyFieldInfo getColorFieldInfo()
public LyTreemapConfiguration.Aggregation getAggregationType()
aggregation
- type.public LyFieldInfo getAggregationFieldInfo()
public LyInfoList<LyFieldInfo> getHierarchyFieldInfos()
public int getHierarchyLevels()
public boolean isFilterActive()
public boolean isFilterShowAll()
public java.lang.String getMinColor()
public java.lang.String getMaxColor()
public java.lang.String[] getThresholdColors()
public java.lang.String getBorderSizes()
public java.lang.String getLabelStyles()
public java.lang.String getUser()
getUser
in interface LyExtraInfoInterface
public void setSizeFieldInfo(LyFieldInfo sizeField)
sizeField
- Field info used to compute the sizes.public void setHierarchyLevels(int hierarchyLevels)
hierarchyLevels
- number of hierarchy levels.public void setFilterActive(boolean active)
active
- indicates whether filter is active or not.public void setFilterShowAll(boolean showAll)
active
- indicates whether filter shows all objects or not.public void setMinColor(java.lang.String minColor)
minColor
- the new minimum color.public void setMaxColor(java.lang.String maxColor)
minColor
- the new maximum color.public void setColorFieldInfo(LyFieldInfo colorField)
colorField
- Field info used to compute the colors.public void setAggregationType(LyTreemapConfiguration.Aggregation aggregationType)
aggregationType
- aggregation type.public void setAggregationFieldInfo(LyFieldInfo aggregationField)
aggregationField
- Field info used to compute aggregations.public void setFilter(LyFilter filter)
filter
- the new filter.public void setThresholdColors(java.lang.String[] colors)
colors
- the list of threshold colors.public void setBorderSizes(java.lang.String borderSizes)
borderSizes
- the new border sizes.public void setLabelStyles(java.lang.String labelStyles)
labelStyles
- the new label styles.public void setHierarchyFieldInfos(LyInfoList<LyFieldInfo> fieldInfos)
fieldInfos
- List of hierarchy field infos, may be null.
|
(c) January 2013 - W4 S.A. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |