Package com.stimulsoft.report.components.simplecomponents

Class StiCheckBox

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.components.simplecomponents.StiCheckBox

All Implemented Interfaces:

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

Direct Known Subclasses:

StiTableCellCheckBox

public class StiCheckBox
extends StiComponent
implements IStiBorder, IStiTextBrush, IStiEditable, IStiBrush, IStiBreakable, IStiExportImageExtended

Class describes the component - Check Box.

Field Summary

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
StiCheckBox()	Creates a new component of the type StiCheckBox.
StiCheckBox(StiRectangle rect)	Creates a new component of the type StiCheckBox.

Method Summary

Modifier and Type	Method	Description
final boolean	Break(StiComponent dividedComponent, double devideFactor, StiRefObject<Double> divideLine, StiRefObject<Boolean> haveBreaked)	Divides content of components in two parts.
Object	clone(boolean cloneProperties)	Creates a new object that is a copy of the current instance.
void	convert(StiUnit oldUnit, StiUnit newUnit)	Convertes component from one unit into another.
final StiBorder	getBorder()	Gets or sets border of the component.
final StiBrush	getBrush()	Gets or sets a brush to fill a component.
boolean	getCanBreak()	Gets or sets value which indicates whether the component can or cannot break its contents on several pages.
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.
final StiCheckedExpression	getChecked()	Gets or sets an expression which used to calculate check state.
final Object	getCheckedValue()	Gets or sets checked value.
final StiCheckStyle	getCheckStyle()	Deprecated.
final StiCheckStyle	getCheckStyleForFalse()	Gets or sets check style for false value.
final StiCheckStyle	getCheckStyleForTrue()	Gets or sets check style for true value.
final StiColor	getContourColor()	Gets or sets a contour color.
boolean	getEditable()	Gets or sets value indicates that a component can be edited in the window of viewer.
StiEventsCollection	getEvents()	Return events collection of this component.
final String	getExcelDataValue()	Gets or sets excel data value.
StiExcelValueExpression	getExcelValue()	Gets or sets an expression used for export data to Excel.
final StiGetCheckedEvent	getGetCheckedEvent()	Occurs when state is being checked.
final StiGetExcelValueEvent	getGetExcelValueEvent()	Occurs when the ExcelValue is calculated.
String	getLocalizedCategory()	Gets a localized name of the component category.
String	getLocalizedName()	Gets a localized component name.
final double	getSize()	Gets or sets a contour size.
final StiBrush	getTextBrush()	Gets or sets a brush to draw text.
int	getToolboxPosition()	Gets value to sort a position in the toolbox.
final String	getValues()	Gets or sets string which describes true and false values.
void	invokeEvents()	Invokes all events for this components.
final void	InvokeGetChecked(StiComponent sender, StiValueEventArgs e)	Raises the GetChecked event.
void	InvokeGetExcelValue(StiComponent sender, StiGetExcelValueEventArgs e)
final boolean	isChecked()
boolean	isExportAsImage(StiExportFormat format)
final boolean	isUnchecked()
void	LoadFromJsonObject(JSONObject jObject)
protected void	OnGetChecked(StiValueEventArgs e)	Raises the GetChecked event.
protected void	OnGetExcelValue(StiGetExcelValueEventArgs e)	Raises the GetExcelValue event.
void	saveState(String stateName)	Saves the current state of an object.
String	SaveState()	Saves state of editable value.
JSONObject	SaveToJsonObject(StiJsonSaveMode mode)
final void	setBorder(StiBorder value)
final void	setBrush(StiBrush value)
void	setCanBreak(boolean value)
void	setCanGrow(boolean value)
void	setCanShrink(boolean value)
final void	setChecked(StiCheckedExpression value)
final void	setCheckedValue(Object value)
final void	setCheckStyle(StiCheckStyle value)	Deprecated.
final void	setCheckStyleForFalse(StiCheckStyle value)
final void	setCheckStyleForTrue(StiCheckStyle value)
final void	setContourColor(StiColor value)
void	setEditable(boolean value)
final void	setExcelDataValue(String value)
void	setExcelValue(StiExcelValueExpression value)
final void	setGetCheckedEvent(StiGetCheckedEvent value)
final void	setGetExcelValueEvent(StiGetExcelValueEvent value)
final void	setSize(double value)
final void	setTextBrush(StiBrush value)
final void	setValues(String value)

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

addSize, AllowPrintOn, applyConditions, canContainIn, CheckForParentComponent, clearAllStates, ClearAllStates, ClearContents, clone, ComponentToPage, ComponentToPage, ComponentToPage, 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, GetComponentStyle, getComponentType, getConditions, getContainer, getCurrentBookmark, getDataBand, GetDataBand, getDefaultClientRectangle, getDelimiterComponent, getDisplayRectangle, getDisplayRectangle1, getDockable, getDockRegion, getDockRegion, getDockStyle, getDoubleClickEvent, getDrillDownParameters, getEnabled, getExpressions, getForceRedrawAll, getGetBookmarkEvent, getGetDrillDownReportEvent, getGetHyperlinkEvent, getGetTagEvent, getGetToolTipEvent, getGroupHeaderBand, GetGroupHeaderBand, getGrowToHeight, getGuid, getHeight, getHighlightState, getHyperlink, getHyperlinkValue, getIgnoreNamingRule, getImage, getImage, getInherited, getInteraction, 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, getToolTip, getToolTipValue, getTop, getUseParentStyles, getWidth, incrementtTop, InternalRender, invert, InvokeAfterPrint, InvokeBeforePrint, InvokeBeginRender, invokeBlockly, InvokeClick, InvokeDoubleClick, InvokeEndRender, 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, select, setAfterPrintEvent, setAlias, setAnchor, setBeforePrintEvent, setBookmark, setBookmarkValue, 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.IStiEditable

RestoreState

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

getImage

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

getImage

Constructor Details

StiCheckBox

public StiCheckBox()

Creates a new component of the type StiCheckBox.

StiCheckBox

public StiCheckBox(StiRectangle rect)

Creates a new component of the type StiCheckBox.

Parameters:

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

Method Details

SaveState

public String SaveState()

Description copied from interface: IStiEditable

Saves state of editable value.

Specified by:

SaveState in interface IStiEditable

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

setCanShrink

public void setCanShrink(boolean value)

Specified by:

setCanShrink in interface IStiCanShrink

Overrides:

setCanShrink 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

setCanGrow

public void setCanGrow(boolean value)

Specified by:

setCanGrow in interface IStiCanGrow

Overrides:

setCanGrow in class StiComponent

getBrush

public final StiBrush getBrush()

Gets or sets a brush to fill a component.

Specified by:

getBrush in interface IStiBrush

setBrush

public final void setBrush(StiBrush value)

Specified by:

setBrush in interface IStiBrush

getBorder

public final StiBorder getBorder()

Gets or sets border of the component.

Specified by:

getBorder in interface IStiBorder

setBorder

public final void setBorder(StiBorder value)

Specified by:

setBorder in interface IStiBorder

getTextBrush

public final StiBrush getTextBrush()

Gets or sets a brush to draw text.

Specified by:

getTextBrush in interface IStiTextBrush

setTextBrush

public final void setTextBrush(StiBrush value)

Specified by:

setTextBrush in interface IStiTextBrush

getEditable

public boolean getEditable()

Gets or sets value indicates that a component can be edited in the window of viewer.

Specified by:

getEditable in interface IStiEditable

setEditable

public void setEditable(boolean value)

Specified by:

setEditable in interface IStiEditable

clone

public Object clone(boolean cloneProperties)

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

Overrides:

clone in class StiComponent

Returns:

A new object that is a copy of this instance.

getCanBreak

public boolean getCanBreak()

Description copied from interface: IStiBreakable

Gets or sets value which indicates whether the component can or cannot break its contents on several pages.

Specified by:

getCanBreak in interface IStiBreakable

setCanBreak

public void setCanBreak(boolean value)

Specified by:

setCanBreak in interface IStiBreakable

Break

public final boolean Break(StiComponent dividedComponent,
 double devideFactor,
 StiRefObject<Double> divideLine,
 StiRefObject<Boolean> haveBreaked)

Divides content of components in two parts. Returns result of dividing. If true, then component is successful divided.

Specified by:

Break in interface IStiBreakable

Parameters:

dividedComponent - Component for store part of content.

Returns:

If true, then component is successful divided.

getEvents

public StiEventsCollection getEvents()

Return events collection of this component.

Overrides:

getEvents in class StiComponent

getToolboxPosition

public int getToolboxPosition()

Gets value to sort a position in the toolbox.

Overrides:

getToolboxPosition in class StiComponent

getLocalizedCategory

public String getLocalizedCategory()

Gets a localized name of the component category.

Overrides:

getLocalizedCategory in class StiBase

getLocalizedName

public String getLocalizedName()

Gets a localized component name.

Overrides:

getLocalizedName in class StiBase

invokeEvents

public void invokeEvents()

Invokes all events for this components.

Overrides:

invokeEvents in class StiComponent

OnGetChecked

protected void OnGetChecked(StiValueEventArgs e)

Raises the GetChecked event.

InvokeGetChecked

public final void InvokeGetChecked(StiComponent sender,
 StiValueEventArgs e)

Raises the GetChecked event.

InvokeGetExcelValue

public void InvokeGetExcelValue(StiComponent sender,
 StiGetExcelValueEventArgs e)

getGetCheckedEvent

public final StiGetCheckedEvent getGetCheckedEvent()

Occurs when state is being checked.

setGetCheckedEvent

public final void setGetCheckedEvent(StiGetCheckedEvent value)

OnGetExcelValue

protected void OnGetExcelValue(StiGetExcelValueEventArgs e)

Raises the GetExcelValue event.

getGetExcelValueEvent

public final StiGetExcelValueEvent getGetExcelValueEvent()

Occurs when the ExcelValue is calculated.

setGetExcelValueEvent

public final void setGetExcelValueEvent(StiGetExcelValueEvent value)

getCheckedValue

public final Object getCheckedValue()

Gets or sets checked value.

setCheckedValue

public final void setCheckedValue(Object value)

getChecked

public final StiCheckedExpression getChecked()

Gets or sets an expression which used to calculate check state.

setChecked

public final void setChecked(StiCheckedExpression value)

getExcelDataValue

public final String getExcelDataValue()

Gets or sets excel data value.

setExcelDataValue

public final void setExcelDataValue(String value)

getExcelValue

public StiExcelValueExpression getExcelValue()

Gets or sets an expression used for export data to Excel.

setExcelValue

public void setExcelValue(StiExcelValueExpression value)

isChecked

public final boolean isChecked()

isUnchecked

public final boolean isUnchecked()

getContourColor

public final StiColor getContourColor()

Gets or sets a contour color.

setContourColor

public final void setContourColor(StiColor value)

getSize

public final double getSize()

Gets or sets a contour size.

setSize

public final void setSize(double value)

getCheckStyle

@Deprecated
public final StiCheckStyle getCheckStyle()

Deprecated.

This property is obsoleted. Please use properties CheckStyleForTrue and CheckStyleForFalse.

setCheckStyle

@Deprecated
public final void setCheckStyle(StiCheckStyle value)

Deprecated.

getValues

public final String getValues()

Gets or sets string which describes true and false values.

setValues

public final void setValues(String value)

getCheckStyleForTrue

public final StiCheckStyle getCheckStyleForTrue()

Gets or sets check style for true value.

setCheckStyleForTrue

public final void setCheckStyleForTrue(StiCheckStyle value)

getCheckStyleForFalse

public final StiCheckStyle getCheckStyleForFalse()

Gets or sets check style for false value.

setCheckStyleForFalse

public final void setCheckStyleForFalse(StiCheckStyle value)

convert

public void convert(StiUnit oldUnit,
 StiUnit newUnit)

Description copied from interface: IStiUnitConvert

Convertes component from one unit into another.

Specified by:

convert in interface IStiUnitConvert

Overrides:

convert in class StiComponent

Parameters:

oldUnit - Old units.

newUnit - New units.

saveState

public void saveState(String stateName)

Description copied from class: StiComponent

Saves the current state of an object.

Specified by:

saveState in interface IStiStateSaveRestore

Overrides:

saveState in class StiComponent

Parameters:

stateName - A name of the state being saved.

isExportAsImage

public boolean isExportAsImage(StiExportFormat format)

Specified by:

isExportAsImage in interface IStiExportImageExtended

Overrides:

isExportAsImage in class StiComponent

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