Package com.stimulsoft.report.infographics.gauge

Class StiGauge

java.lang.Object

com.stimulsoft.base.serializing.StiSerializedObject

com.stimulsoft.base.services.StiService

com.stimulsoft.report.StiBase

com.stimulsoft.report.components.StiComponent

com.stimulsoft.report.infographics.gauge.StiGauge

All Implemented Interfaces:

IStiAppExpressionCollection, IStiJsonReportObject, IStiSerializable, IStiSerializableRef, IStiName, IStiBorder, IStiBrush, IStiCanGrow, IStiCanShrink, IStiComponentGuid, IStiConditions, IStiExportImage, IStiExportImageExtended, IStiGrowToHeight, IStiInteraction, IStiPrintOn, IStiSelect, IStiShift, IStiUnitConvert, IStiReportProperty, IStiInherited, IStiStateSaveRestore, Cloneable

public class StiGauge
extends StiComponent
implements IStiExportImageExtended, IStiBorder, IStiBrush

Copyright Stimulsoft

Field Summary

Fields

Modifier and Type	Field	Description
StiGaugeContextPainter	painter
boolean	shortValue
StiFormatService	valueFormat

Fields inherited from class com.stimulsoft.report.components.StiComponent

canGrow, canShrink, componentPlacement, conditions, currentPointer, eventFlags, expressions, interaction, isRendered, page, parent, parentBookmark, parentPointer, PropertyComponentStyle, PropertyDelimiterComponent, PropertyDockable, PropertyInherited, PropertyLinked, PropertyLocked, PropertyMaxSize, PropertyMinSize, PropertyPlaceOnToolbox, PropertyRenderedCount, PropertyRestrictions, PropertySelectionTick, PropertyShowQuickButtons, PropertyUseParentStyles, top, width

Fields inherited from class com.stimulsoft.base.services.StiService

properties

Fields inherited from interface com.stimulsoft.base.serializing.interfaceobject.IStiSerializableRef

REFERENCE_EMPTY, REFERENCE_REPORT

Constructor Summary

Constructors

Constructor	Description
StiGauge()	Creates a new StiGauge.
StiGauge(StiRectangle rect)	Creates a new StiGauge.

Method Summary

Modifier and Type	Method	Description
void	applyStyle(IStiGaugeStyle style)
Object	clone(boolean cloneProperties)	Creates a new object that is a copy of the current instanc.
StiComponent	createNew()
void	drawGauge(StiGaugeContextPainter context)
StiBorder	getBorder()	frame of the component.
StiBrush	getBrush()	a brush to fill a component.
StiGaugeCalculationMode	getCalculationMode()
boolean	getCanGrow()	gets or sets a value which indicates that this object can grow.
boolean	getCanShrink()	gets or sets value which indicates that this object can shrink.
StiComponentId	getComponentId()
String	getComponentStyle()	gets or sets a style of a component.
String	getCustomStyleName()
StiRectangle	getDefaultClientRectangle()	gets the default client area of a component.
IStiGaugeStyle	getGaugeStyle()
boolean	getGrowToHeight()	gets or sets a value which indicates that the height of this component increases/decreases to the bottom of a container.
BufferedImage	getImage(double zoom)
BufferedImage	getImage(double zoom, StiExportFormat format)
StiInteraction	getInteraction()	gets interaction options of this component.
boolean	getIsAnimation()
String	getLocalizedCategory()	Gets a localized name of the component category.
String	getLocalizedName()	Gets a localized component name.
double	getMaximum()
double	getMinimum()
StiScaleMode	getMode()
StiScaleCollection	getScales()
IStiGaugeStyle	getStyle()	style of the chart.
StiGaugeType	getType()
boolean	getUseParentStyles()	gets or sets a value which indicates that this component must use styles from parent component.
boolean	isAllowApplyStyle()
boolean	isExportAsImage(StiExportFormat format)
boolean	isShortValue()
void	LoadFromJsonObject(JSONObject jObject)
JSONObject	SaveToJsonObject(StiJsonSaveMode mode)
void	setAllowApplyStyle(boolean allowApplyStyle)
void	setBorder(StiBorder border)	frame of the component.
void	setBrush(StiBrush brush)	a brush to fill a component.
void	setCalculationMode(StiGaugeCalculationMode calculationMode)
void	setCustomStyleName(String customStyleName)
void	setIsAnimation(boolean value)
void	setMaximum(double maximum)
void	setMinimum(double minimum)
void	setMode(StiScaleMode mode)
void	setScales(StiScaleCollection scales)
void	setShortValue(boolean shortValue)
void	setStyle(IStiGaugeStyle value)	style of the chart.
void	setType(StiGaugeType type)

Methods inherited from class com.stimulsoft.report.components.StiComponent

addSize, AllowPrintOn, applyConditions, canContainIn, CheckForParentComponent, clearAllStates, ClearAllStates, ClearContents, clone, ComponentToPage, ComponentToPage, ComponentToPage, convert, convert, decrementTop, doBookmark, DoBookmark, DockToContainer, DockToContainer, doGetBookmark, DoOffsetRect, doPointer, doPointer, fillComponentPlacement, getActualSize, getAfterPrintEvent, getAlias, getAllowDelete, getAnchor, getBeforePrintEvent, getBookmark, getBookmarkValue, getBottom, getBuilder, getClickEvent, getClientRectangle, getComponentPlacement, GetComponentStyle, getComponentType, getConditions, getContainer, getCurrentBookmark, getDataBand, GetDataBand, getDelimiterComponent, getDisplayRectangle, getDisplayRectangle1, getDockable, getDockRegion, getDockRegion, getDockStyle, getDoubleClickEvent, getDrillDownParameters, getEnabled, getEvents, getExpressions, getForceRedrawAll, getGetBookmarkEvent, getGetDrillDownReportEvent, getGetHyperlinkEvent, getGetTagEvent, getGetToolTipEvent, getGroupHeaderBand, GetGroupHeaderBand, getGuid, getHeight, getHighlightState, getHyperlink, getHyperlinkValue, getIgnoreNamingRule, getImage, getImage, getInherited, getInvalidateOnMouseOver, getIsCross, getIsDesigning, getIsEnabled, getIsEventEmpty, getIsExporting, getIsgetTagHandlerEmpty, getIsPrinting, getIsRendered, getIsSelected, getLeft, getLevel, getLinked, getLocked, getMaxSize, getMeasureGraphics, getMinSize, getMouseEnterEvent, getMouseLeaveEvent, getPage, getPaintRectangle, getPaintRectangle, getPaintRectangle, getParent, getParentBookmark, getPlaceOnToolbox, getPointer, getPointerValue, getPrintable, getPrintOn, getPriority, getQuickInfo, getRenderedCount, getReport, getRestrictions, getRight, getSelectionTick, getSelectRectangle, getServiceCategory, getServiceType, getShift, getShiftMode, getShowQuickButtons, getStates, getTag, getTagStrValue, getTagValue, getToolboxPosition, getToolTip, getToolTipValue, getTop, getWidth, incrementtTop, InternalRender, invert, InvokeAfterPrint, InvokeBeforePrint, InvokeBeginRender, invokeBlockly, InvokeClick, InvokeDoubleClick, InvokeEndRender, invokeEvents, InvokegetBookmark, InvokegetDrillDownReport, InvokegetHyperlink, InvokegetTag, InvokegetToolTip, InvokeMouseEnter, InvokeMouseLeave, InvokePainted, invokePainting, invokeScript, invokeScript, invokeScript, isAutomaticDock, isDesigning, IsParentSelect, NewGuid, OnAfterPrint, OnBeforePrint, OnClick, OnDoubleClick, OngetBookmark, OngetDrillDownReport, OngetHyperlink, OngetTag, OngetToolTip, OnMouseEnter, OnMouseLeave, OnPainted, OnPainting, OnRemoveComponent, packService, PageToComponent, PageToComponent, paint, PlacedOnColumnBand, Prepare, render, reset, Reset, restoreState, RestoreState, saveState, select, setAfterPrintEvent, setAlias, setAnchor, setBeforePrintEvent, setBookmark, setBookmarkValue, setCanGrow, setCanShrink, setClickEvent, setClientRectangle, setComponentPlacement, setComponentStyle, setConditions, setCurrentBookmark, setDelimiterComponent, setDirectDisplayRectangle, setDisplayRectangle, setDockable, setDockStyle, setDoubleClickEvent, setDrillDownParameters, setEnabled, setExpressions, setGetBookmarkEvent, setGetDrillDownReportEvent, setGetHyperlinkEvent, setGetTagEvent, setGetToolTipEvent, setGrowToHeight, setGuid, setHeight, setHeightProp, setHighlightState, setHyperlink, setHyperlinkValue, setIgnoreNamingRule, setInherited, setInteraction, setIsRendered, setIsSelected, setLeft, setLeftProp, setLinked, setLocked, setMaxSize, setMinSize, setMouseEnterEvent, setMouseLeaveEvent, setName, setPage, setPaintRectangle, setParent, setParentBookmark, setPlaceOnToolbox, setPointer, setPointerValue, setPrintable, setPrintOn, setRenderedCount, setReport, SetReportVariables, setRestrictions, setSelectionTick, setSelectRectangle, setShift, setShiftMode, setShowQuickButtons, setStates, setTag, setTagValue, setToolTip, setToolTipValue, setTop, setTopProp, setUseParentStyles, setWidth, setWidthProp, toString, UnPrepare

Methods inherited from class com.stimulsoft.report.StiBase

getName, getServiceName

Methods inherited from class com.stimulsoft.base.services.StiService

getProperties, getServiceEnabled, getServiceInfo, isPropertyPresent, MemberwiseClone, properties, setProperties, setServiceEnabled

Methods inherited from class com.stimulsoft.base.serializing.StiSerializedObject

cleanReference, getReference, setReference

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.stimulsoft.report.components.interfaces.IStiExportImage

getImage

Methods inherited from interface com.stimulsoft.report.components.interfaces.IStiExportImageExtended

getImage

Field Details

shortValue

public boolean shortValue

painter

public StiGaugeContextPainter painter

valueFormat

public StiFormatService valueFormat

Constructor Details

StiGauge

public StiGauge()

Creates a new StiGauge.

StiGauge

public StiGauge(StiRectangle rect)

Creates a new StiGauge.

Parameters:

rect - The rectangle describes size and position of the component.

Method Details

SaveToJsonObject

public JSONObject SaveToJsonObject(StiJsonSaveMode mode)
                            throws JSONException

Specified by:

SaveToJsonObject in interface IStiJsonReportObject

Overrides:

SaveToJsonObject in class StiComponent

Throws:

JSONException

LoadFromJsonObject

public void LoadFromJsonObject(JSONObject jObject)
                        throws JSONException

Specified by:

LoadFromJsonObject in interface IStiJsonReportObject

Overrides:

LoadFromJsonObject in class StiComponent

Throws:

JSONException

getGaugeStyle

public IStiGaugeStyle getGaugeStyle()

getComponentId

public StiComponentId getComponentId()

getMode

public StiScaleMode getMode()

setMode

public void setMode(StiScaleMode mode)

getMinimum

public double getMinimum()

setMinimum

public void setMinimum(double minimum)

getMaximum

public double getMaximum()

setMaximum

public void setMaximum(double maximum)

getType

public StiGaugeType getType()

setType

public void setType(StiGaugeType type)

getCalculationMode

public StiGaugeCalculationMode getCalculationMode()

setCalculationMode

public void setCalculationMode(StiGaugeCalculationMode calculationMode)

isAllowApplyStyle

public boolean isAllowApplyStyle()

setAllowApplyStyle

public void setAllowApplyStyle(boolean allowApplyStyle)

clone

public Object clone(boolean cloneProperties)

Description copied from class: StiComponent

Creates a new object that is a copy of the current instanc.

Overrides:

clone in class StiComponent

Returns:

A new object that is a copy of this instance.

getImage

public BufferedImage getImage(double zoom)

getImage

public BufferedImage getImage(double zoom,
 StiExportFormat format)

isExportAsImage

public boolean isExportAsImage(StiExportFormat format)

Specified by:

isExportAsImage in interface IStiExportImageExtended

Overrides:

isExportAsImage in class StiComponent

getBorder

public StiBorder getBorder()

frame of the component.

Specified by:

getBorder in interface IStiBorder

Returns:

the border

setBorder

public void setBorder(StiBorder border)

frame of the component.

Specified by:

setBorder in interface IStiBorder

Parameters:

border - the border to set

getBrush

public StiBrush getBrush()

a brush to fill a component.

Specified by:

getBrush in interface IStiBrush

Returns:

the brush

setBrush

public void setBrush(StiBrush brush)

a brush to fill a component.

Specified by:

setBrush in interface IStiBrush

Parameters:

brush - the brush to set

isShortValue

public boolean isShortValue()

Returns:

the shortValue

setShortValue

public void setShortValue(boolean shortValue)

Parameters:

shortValue - the shortValue to set

getLocalizedCategory

public String getLocalizedCategory()

Description copied from class: StiBase

Gets a localized name of the component category.

Overrides:

getLocalizedCategory in class StiBase

getLocalizedName

public String getLocalizedName()

Description copied from class: StiBase

Gets a localized component name.

Overrides:

getLocalizedName in class StiBase

getDefaultClientRectangle

public StiRectangle getDefaultClientRectangle()

Description copied from class: StiComponent

gets the default client area of a component.

Overrides:

getDefaultClientRectangle in class StiComponent

getComponentStyle

public String getComponentStyle()

Description copied from class: StiComponent

gets or sets a style of a component.

Overrides:

getComponentStyle in class StiComponent

getUseParentStyles

public boolean getUseParentStyles()

Description copied from class: StiComponent

gets or sets a value which indicates that this component must use styles from parent component.

Overrides:

getUseParentStyles in class StiComponent

getCanGrow

public boolean getCanGrow()

Description copied from class: StiComponent

gets or sets a value which indicates that this object can grow.

Specified by:

getCanGrow in interface IStiCanGrow

Overrides:

getCanGrow in class StiComponent

getCanShrink

public boolean getCanShrink()

Description copied from class: StiComponent

gets or sets value which indicates that this object can shrink.

Specified by:

getCanShrink in interface IStiCanShrink

Overrides:

getCanShrink in class StiComponent

getGrowToHeight

public boolean getGrowToHeight()

Description copied from class: StiComponent

gets or sets a value which indicates that the height of this component increases/decreases to the bottom of a container.

Specified by:

getGrowToHeight in interface IStiGrowToHeight

Overrides:

getGrowToHeight in class StiComponent

getInteraction

public StiInteraction getInteraction()

Description copied from class: StiComponent

gets interaction options of this component.

Specified by:

getInteraction in interface IStiInteraction

Overrides:

getInteraction in class StiComponent

getStyle

public IStiGaugeStyle getStyle()

style of the chart.

Returns:

the style

setStyle

public void setStyle(IStiGaugeStyle value)

style of the chart.

Parameters:

style - the style to set

getCustomStyleName

public String getCustomStyleName()

Returns:

the customStyleName

setCustomStyleName

public void setCustomStyleName(String customStyleName)

Parameters:

customStyleName - the customStyleName to set

getScales

public StiScaleCollection getScales()

Returns:

the scales

setScales

public void setScales(StiScaleCollection scales)

Parameters:

scales - the scales to set

getIsAnimation

public boolean getIsAnimation()

setIsAnimation

public void setIsAnimation(boolean value)

drawGauge

public void drawGauge(StiGaugeContextPainter context)

createNew

public StiComponent createNew()

applyStyle

public void applyStyle(IStiGaugeStyle style)