Package overit.geocall.basic.ui.control

Class ChartPie

java.lang.Object

overit.geocall.platform.ui.UINode

overit.geocall.ui.Component

overit.geocall.ui.Control

overit.geocall.basic.ui.control.ChartBase

overit.geocall.basic.ui.control.ChartPie

All Implemented Interfaces:

Serializable, overit.geocall.marks.MethodExposer, overit.geocall.marks.NameExposer, Arrangeable, Badgeable, Identified, Tool, overit.geocall.ux.configurability.UIConfigurable, overit.geocall.ux.edm.ModelConfigurable

@Component
public class ChartPie
extends ChartBase

This class extends ChartBase and implements a pie chart.

See Also:

• Serialized Form

GCApi:

component

Nested Class Summary

Nested classes/interfaces inherited from class overit.geocall.ui.Component

Component.Configurable, Component.ConfigurableAttribute, Component.ConfigurableAttributes, Component.FilterCriteria, Component.Registry

Field Summary

Fields inherited from class overit.geocall.ui.Control

_blank, _cleaner, _dblink, _enabled, _ro, _title, altEventIconsList, altIcon, ariaDescription, ariaLabel, badge, badgeformat, FILTER_PREFIXES, LABEL_ATTRIBUTE, LABEL_IN_LINE_ATTRIBUTE, STATE_BLANK, STATE_NORMAL, STATE_RO, STATE_ROBLANK

Fields inherited from class overit.geocall.ui.Component

_basic, _childrenContainers, _currentId, _gridalign, _gridcols, _gridrows, _gridvalign, _iconElement, _id, _keylabel, _label, _layoutName, _name, _parentContainer, _registryName, _shortcut, _tabindex, _transformations, _valuesContainer, aliasField, BR, configHidden, configuredLabel, configuredLabelInLine, defaultHidden, ELEMENT_BR, ELEMENT_NULL, entityContainer, entityName, extendedField, fullHeight, important, labelInLine, layoutLabel, PIXEL_IMG, safeInlineService

Constructor Summary

Constructors

Modifier	Constructor	Description
	ChartPie()	Creates a new instance of ChartPie
protected	ChartPie(Holder<ChartScriptBuilder> chartScriptBuilderHolder, Holder<ChartPieConfigurationBuilder> chartPieConfigurationBuilderHolder)

Method Summary

Modifier and Type	Method	Description
protected void	addEventHandlers(ChartScriptBuilder scriptBuilder)
protected String	buildJsonChartConfig()
protected Holder<ChartPieConfigurationBuilder>	getChartPieConfigurationBuilderHolder()
org.apache.ecs.Element	getContentHtml(Object generationHandle, EntitySet es)	Returns the html code that represents the active part of the component, i.e. the field and the validation scripts
String	getEvent()	Returns the name of the event triggered when the user clicks on an element of the legend box.
String	getItemEvent()	Returns the name of the event triggered when the user clicks on an element of the chart.
overit.geocall.charts.ChartLabelBox	getItemLabelBox()	Returns the label box used for the labels of the elements of the chart.
overit.geocall.charts.ChartFont	getItemLabelFont()	Returns the font used for the labels of the elements of the chart.
String	getItemLabelFormat()	Returns the format used for the labels of the elements of the chart.
ListAttribute	getItemLabels()	Returns the labels of the elements of the chart.
String	getItemParam()	Returns the parameter for the event triggered when the user clicks on an element of the chart.
String	getItemTooltipFormat()	Returns the format used for the tooltip messages.
ListAttribute	getItemTooltips()	Returns the tooltip messages used for the elements of the chart.
ListAttribute	getLabels()	Returns the labels of the elements of the chart.
String	getParam()	Returns the parameter for the event triggered when the user clicks on an element of the legend box.
double	getRing()	Returns the size of the ring's section.
overit.geocall.charts.Serie	getSerie()	Returns the data serie of the chart.
boolean	hasItemLabels()	Returns true if the chart has item labels, false otherwise.
void	setEVENT(String s)	Sets the name of the event triggered when the user clicks on an element of the legend box.
void	setITEMEVENT(String s)	Sets the name of the event triggered when the user clicks on an element of the chart.
void	setItemLabelBox(overit.geocall.charts.ChartLabelBox itemLabelBox)	Sets the label box used for the labels of the elements of the chart.
void	setITEMLABELBOX(String s)	Sets the label box used for the labels of the elements of the chart. ink parameters aren't supported
void	setItemLabelFont(overit.geocall.charts.ChartFont itemLabelFont)	Sets the font used for the labels of the elements of the chart.
void	setITEMLABELFONT(String s)	Sets the font used for the labels of the elements of the chart.
void	setITEMLABELFORMAT(String itemLabelFormat)	Sets the format used for the labels of the elements of the chart.
void	setItemLabels(ListAttribute itemLabels)	Sets the labels of the elements of the chart.
void	setITEMLABELS(String s)	Sets the labels of the elements of the chart.
void	setITEMPARAM(String s)	Sets the parameter for the event triggered when the user clicks on an element of the chart.
void	setItemTooltipFormat(String itemTooltipFormat)	Sets the format used for the tooltip messages.
void	setITEMTOOLTIPFORMAT(String s)	Sets the format used for the tooltip messages.
void	setItemTooltips(ListAttribute itemTooltips)	Sets the tooltip messages used for the elements of the chart.
void	setITEMTOOLTIPS(String s)	Sets the tooltip messages used for the elements of the chart.
void	setLabels(ListAttribute labels)	Sets the labels of the elements of the chart.
void	setLABELS(String s)	Sets the labels of the elements of the chart.
void	setPARAM(String s)	Sets the parameter for the event triggered when the user clicks on an element of the legend box.
void	setRing(double ring)	Sets the size of the ring's section, if greater than 0, the chart will be a doughnut chart.
void	setRING(String s)	Sets the size of the ring's section, if greater than 0, the chart will be a doughnut chart.
void	setSerie(overit.geocall.charts.Serie serie)	Sets the data serie of the chart.
void	setVALUES(String vals)	Sets the values of the data serie of the chart.

Methods inherited from class overit.geocall.basic.ui.control.ChartBase

buildSetupScript, chartChanged, getChartScriptBuilderHolder, getChartStyle, getDescriptionHtml, getGenerationHandle, getHeight, getHiddenHtml, getHtml, getItemSize, getLegendBox, getLegendFont, getMessages, getMessages, getWidth, hasFixedSize, isLegend, setChartStyle, setHeight, setHEIGHT, setItemSize, setITEMSIZE, setLegend, setLEGEND, setLegendBox, setLEGENDBOX, setLegendFont, setLEGENDFONT, setup, setWidth, setWIDTH

Methods inherited from class overit.geocall.ui.Control

avoidNull, clean, getBadgeFormat, getBadgeValue, getBLANK, getCleaner, getConfigurableProperties, getDAValues, getDBLINK, getKEYLABEL, getLABEL, getRO, getState, getTITLE, getValues, getWM, isEnabled, isEnabledBasedOnFunction, isFunctionEnabled, isImportant, isRoBasedOnFunction, nameWithNoFilterPrefix, setALTEVENTICON, setALTICON, setARIADESCRIPTION, setARIALABEL, setBADGEFORMAT, setBADGEVALUE, setBLANK, setCLEANER, setConfiguredProperty, setDBLINK, setENABLED, setFUNCTION, setModelProperties, setRO, setTitle, setTITLE

Methods inherited from class overit.geocall.ui.Component

adapt, ajaxQuery, appendAttribute, buildDisplayScript, calcKeyLabel, calcLabel, calcShortcut, canBeConfigured, changed, clearConfiguredProperties, componentIterator, componentSize, connect, containerIterator, createAjaxFrame, deprecate, fillSetupScript, generateFlexableFullHeightContainer, generateId, getBASIC, getBoolean, getBoolean, getChildrenComponents, getChildrenContainers, getDefaultLabel, getDefaultLayoutLabel, getEntityContainer, getEntityName, getFullHeight, getGridAlign, getGridCols, getGridRows, getGridVAlign, getHtmlLabel, getHtmlLabel, getIcon, getId, getIdentity, getint, getLayoutLabel, getLayoutName, getNAME, getParentComponent, getParentContainer, getPublishedChildrenList, getRegistryName, getSHORTCUT, getTabIndex, getTeacher, getValuesContainer, getWindow, initChilds, isActivable, isActive, isAliasField, isConfigHidden, isDefaultHidden, isExtendedField, isLabelInLine, onInit, setActivable, setActive, setAliasField, setBASIC, setConfigHidden, setDEFAULTHIDDEN, setEntityName, setExtendedField, setFULLHEIGHT, setGRIDALIGN, setGRIDCOLS, setGRIDROWS, setGRIDVALIGN, setICON, setIdentity, setIMPORTANT, setLabel, setLABEL, setLABELINLINE, setLAYOUTLABEL, setLAYOUTNAME, setNAME, setREGISTRYNAME, setTooltip, setValuesContainer, stringForJs, tabIndexer

Methods inherited from class overit.geocall.platform.ui.UINode

addChild, addChildText, getChildren, getNodeId, getParent, getRoot, getSchema, setNodeId, setParent, setSchema

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface overit.geocall.ui.Badgeable

badgeFormat, makeBadgedIcon

Constructor Details

ChartPie

public ChartPie()

Creates a new instance of ChartPie

ChartPie

protected ChartPie(Holder<ChartScriptBuilder> chartScriptBuilderHolder,
 Holder<ChartPieConfigurationBuilder> chartPieConfigurationBuilderHolder)

Method Details

getRing

public double getRing()

Returns the size of the ring's section.

Returns:

The size of the ring's section

setRing

public void setRing(double ring)

Sets the size of the ring's section, if greater than 0, the chart will be a doughnut chart.

Parameters:

ring - The size of the ring's section

setRING

public void setRING(String s)

Sets the size of the ring's section, if greater than 0, the chart will be a doughnut chart.

Parameters:

s - The size of the ring's section

getSerie

public overit.geocall.charts.Serie getSerie()

Returns the data serie of the chart.

Returns:

The data serie of the chart

setSerie

public void setSerie(overit.geocall.charts.Serie serie)

Sets the data serie of the chart.

Parameters:

serie - The data serie of the chart

setVALUES

public void setVALUES(String vals)

Sets the values of the data serie of the chart.

Parameters:

vals - A ListAttribute in which every element, separated from the others by the | character, represents one value of the data serie

getLabels

public ListAttribute getLabels()

Returns the labels of the elements of the chart.

Returns:

The labels of the elements of the chart

setLabels

public void setLabels(ListAttribute labels)

Sets the labels of the elements of the chart.

Parameters:

labels - The labels of the elements of the chart

setLABELS

public void setLABELS(String s)

Sets the labels of the elements of the chart.

Parameters:

s - A ListAttribute in which every element, separated from the others by the | character, represents one label of the elements of the chart

getItemEvent

public String getItemEvent()

Returns the name of the event triggered when the user clicks on an element of the chart.

Returns:

The name of the event triggered when the user clicks on an element of the chart

setITEMEVENT

public void setITEMEVENT(String s)

Sets the name of the event triggered when the user clicks on an element of the chart.

Parameters:

s - The name of the event triggered when the user clicks on an element of the chart

getItemParam

public String getItemParam()

Returns the parameter for the event triggered when the user clicks on an element of the chart.

Returns:

The parameter for the event triggered when the user clicks on an element of the chart

setITEMPARAM

public void setITEMPARAM(String s)

Sets the parameter for the event triggered when the user clicks on an element of the chart.

Parameters:

s - The parameter for the event triggered when the user clicks on an element of the chart

getEvent

public String getEvent()

Returns the name of the event triggered when the user clicks on an element of the legend box.

Returns:

The name of the event triggered when the user clicks on an element of the legend box

setEVENT

public void setEVENT(String s)

Sets the name of the event triggered when the user clicks on an element of the legend box.

Parameters:

s - The name of the event triggered when the user clicks on an element of the legend box

getParam

public String getParam()

Returns the parameter for the event triggered when the user clicks on an element of the legend box.

Returns:

The parameter for the event triggered when the user clicks on an element of the legend box

setPARAM

public void setPARAM(String s)

Sets the parameter for the event triggered when the user clicks on an element of the legend box.

Parameters:

s - The parameter for the event triggered when the user clicks on an element of the legend box

getItemTooltips

public ListAttribute getItemTooltips()

Returns the tooltip messages used for the elements of the chart.

Returns:

The tooltip messages used for the elements of the chart

setItemTooltips

public void setItemTooltips(ListAttribute itemTooltips)

Sets the tooltip messages used for the elements of the chart.

Parameters:

itemTooltips - The tooltip messages used for the elements of the chart

setITEMTOOLTIPS

public void setITEMTOOLTIPS(String s)

Sets the tooltip messages used for the elements of the chart.

Parameters:

s - A ListAttribute in which every element, separated from the others by the | character, represents the message that will appear as a tooltip for the element of the data serie

getItemTooltipFormat

public String getItemTooltipFormat()

Returns the format used for the tooltip messages.

Returns:

The format used for the tooltip messages

setItemTooltipFormat

public void setItemTooltipFormat(String itemTooltipFormat)

Sets the format used for the tooltip messages.

Parameters:

itemTooltipFormat - The format used for the tooltip messages

setITEMTOOLTIPFORMAT

public void setITEMTOOLTIPFORMAT(String s)

Sets the format used for the tooltip messages.

Parameters:

s - The format used for the tooltip messages

hasItemLabels

public boolean hasItemLabels()

Returns true if the chart has item labels, false otherwise.

Returns:

True if the chart has item labels, false otherwise

getItemLabelFormat

public String getItemLabelFormat()

Returns the format used for the labels of the elements of the chart.

Returns:

The format used for the labels of the elements of the chart

setITEMLABELFORMAT

public void setITEMLABELFORMAT(String itemLabelFormat)

Sets the format used for the labels of the elements of the chart.

Parameters:

itemLabelFormat - The format used for the labels of the elements of the chart

getItemLabels

public ListAttribute getItemLabels()

Returns the labels of the elements of the chart.

Returns:

The labels of the elements of the chart

setItemLabels

public void setItemLabels(ListAttribute itemLabels)

Sets the labels of the elements of the chart.

Parameters:

itemLabels - The labels of the elements of the chart

setITEMLABELS

public void setITEMLABELS(String s)

Sets the labels of the elements of the chart.

Parameters:

s - A ListAttribute in which every element, separated from the others by the | character, represents the label of the corresponding element of the chart

getItemLabelFont

public overit.geocall.charts.ChartFont getItemLabelFont()

Returns the font used for the labels of the elements of the chart.

Returns:

The font used for the labels of the elements of the chart

setItemLabelFont

public void setItemLabelFont(overit.geocall.charts.ChartFont itemLabelFont)

Sets the font used for the labels of the elements of the chart.

Parameters:

itemLabelFont - The font used for the labels of the elements of the chart

setITEMLABELFONT

public void setITEMLABELFONT(String s)

Sets the font used for the labels of the elements of the chart.

Parameters:

s - A string that defines the font, with the format: name,variant,dimension,color.

getItemLabelBox

public overit.geocall.charts.ChartLabelBox getItemLabelBox()

Returns the label box used for the labels of the elements of the chart.

Returns:

The label box used for the labels of the elements of the chart

setItemLabelBox

public void setItemLabelBox(overit.geocall.charts.ChartLabelBox itemLabelBox)

Sets the label box used for the labels of the elements of the chart.

Parameters:

itemLabelBox - The label box used for the labels of the elements of the chart

setITEMLABELBOX

public void setITEMLABELBOX(String s)

Sets the label box used for the labels of the elements of the chart. ink parameters aren't supported

Parameters:

s - A string in the format: background-color,,border thickness,,.

getChartPieConfigurationBuilderHolder

protected Holder<ChartPieConfigurationBuilder> getChartPieConfigurationBuilderHolder()

getContentHtml

public org.apache.ecs.Element getContentHtml(Object generationHandle,
 EntitySet es)

Description copied from interface: Arrangeable

Returns the html code that represents the active part of the component, i.e. the field and the validation scripts

Specified by:

getContentHtml in interface Arrangeable

Overrides:

getContentHtml in class ChartBase

Parameters:

generationHandle - the unique generatin handle

es - the page entity set

Returns:

The html code of the component

buildJsonChartConfig

protected String buildJsonChartConfig()

Specified by:

buildJsonChartConfig in class ChartBase

addEventHandlers

protected void addEventHandlers(ChartScriptBuilder scriptBuilder)

Overrides:

addEventHandlers in class ChartBase