Package com.stimulsoft.report.dialogs

Class StiButtonControl

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.complexcomponents.StiContainer

com.stimulsoft.report.dialogs.StiReportControl

com.stimulsoft.report.dialogs.StiButtonControl

All Implemented Interfaces:

IStiAppExpressionCollection, IStiJsonReportObject, IStiForceSerializable, IStiSerializable, IStiSerializableRef, IStiSerializableToAttributes, IStiName, IStiBorder, IStiBreakable, IStiBrush, IStiCanGrow, IStiCanShrink, IStiComponentGuid, IStiConditions, IStiGrowToHeight, IStiInteraction, IStiPrintOn, IStiSelect, IStiShift, IStiUnitConvert, IStiReportControl, IStiReportProperty, IStiIgnoryStyle, IStiInherited, IStiStateSaveRestore, Cloneable

public class StiButtonControl
extends StiReportControl

Represents a Windows button control.

Field Summary

Fields inherited from class com.stimulsoft.report.components.complexcomponents.StiContainer

border, brush, collapsingIndex, components, engine, ParentComponentIsBand, ParentComponentIsCrossBand, PropertyBlocked

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
StiButtonControl()	Creates a new StiButtonControl.
StiButtonControl(StiRectangle rect)	Creates a new StiButtonControl.

Method Summary

Modifier and Type	Method	Description
StiColor	getBackColor()	Gets or sets the background color for the control.
final boolean	getCancel()	Gets or sets the value which indicates which button is clicked when the user presses the ESCAPE key.
final boolean	getDefault()	Gets or sets the value which indicates which button is clicked when the user presses the ENTER key.
final StiDialogResult	getDialogResult()	Gets or sets a value that is returned to the parent form when the button is clicked.
final String	getImage()	Gets or sets the image that is displayed on a button control.
final StiContentAlignment	getImageAlign()	Gets or sets the alignment of the image on the button control.
String	getLocalizedName()	Gets a localized component name.
final String	getText()	Gets or sets the text associated with this control.
final StiContentAlignment	getTextAlign()	Gets or sets the alignment of the text on the button control.
int	getToolboxPosition()	Gets value to sort a position in the toolbox.
void	LoadFromJsonObject(JSONObject jObject)
JSONObject	SaveToJsonObject(StiJsonSaveMode mode)
void	setBackColor(StiColor value)
final void	setCancel(boolean value)
final void	setDefault(boolean value)
final void	setDialogResult(StiDialogResult value)
final void	setImage(String value)
final void	setImageAlign(StiContentAlignment value)
final void	setText(String value)
final void	setTextAlign(StiContentAlignment value)

Methods inherited from class com.stimulsoft.report.dialogs.StiReportControl

canContainIn, clone, convert, getAfterPrintEvent, getBeforePrintEvent, getBookmark, getBorder, getBrush, getCanGrow, getCanShrink, getClickEvent, getComponentStyle, getConditions, getControlWpf, getDefaultClientRectangle, GetDefaultEvent, getDockStyle, getDoubleClickEvent, getEnabled, getEnterEvent, getEvents, getFont, getForeColor, getGetBookmarkEvent, getGetDrillDownReportEvent, getGetHyperlinkEvent, getGetTagEvent, getGetToolTipEvent, getGrowToHeight, getHeight, getHyperlink, getInteraction, getIsReportContainer, getLeaveEvent, getLeft, getLocalizedCategory, getLocation, getMaxSize, getMinSize, getMouseDownEvent, getMouseEnterEvent, getMouseLeaveEvent, getMouseMoveEvent, getMouseUpEvent, getPrintable, getPrintOn, getServiceCategory, getShiftMode, getSize, getTag, getTagValueBinding, getToolTip, getTop, getUseParentStyles, getVisible, getWidth, InvokeEnter, InvokeLeave, InvokeMouseDown, InvokeMouseMove, InvokeMouseUp, packService, setAfterPrintEvent, setBeforePrintEvent, setBookmark, setBorder, setBrush, setCanGrow, setCanShrink, setClickEvent, setComponentStyle, setConditions, setControlWpf, setDockStyle, setDoubleClickEvent, setEnabled, setEnterEvent, setFont, setForeColor, setGetBookmarkEvent, setGetDrillDownReportEvent, setGetHyperlinkEvent, setGetTagEvent, setGetToolTipEvent, setGrowToHeight, setHeight, setHyperlink, setInteraction, setLeaveEvent, setLeft, setLocation, setMaxSize, setMinSize, setMouseDownEvent, setMouseEnterEvent, setMouseLeaveEvent, setMouseMoveEvent, setMouseUpEvent, setPrintable, setPrintOn, setShiftMode, setSize, setTag, setTagValueBinding, setToolTip, setTop, setUseParentStyles, setVisible, setWidth, UpdateReportControl

Methods inherited from class com.stimulsoft.report.components.complexcomponents.StiContainer

AlignTo, AlignToGrid, AlignToGrid, Break, BringToFront, ChangePosition, checkBlockedException, CheckBlockedException, checkLargeHeight, ClearAllStates, clone, clone, ContainerToPage, ContainerToPage, Convert, ConvertSelectedToPage, ConvertToPage, Correct, Correct, correct2, getActualSize, getActualSize, getBlocked, GetBorder, GetBrush, getCanBreak, getClientRectangle, getCollapsedValue, getCollapsingIndex, getCollapsingTreePath, getComponentPlacementForChildren, getComponents, GetComponents, GetComponentsCount, GetComponentsList, getComponentsSelectedRectangle, getComponentType, GetConditions, getContainerInfoV1, getContainerInfoV2, GetContainerInRect, GetContainerInRect2, GetDockableComponent, GetDockStyle, GetFirstSelectableCompanent, GetFont, getGuid, getHasSelected, GetHorAlignment, GetIncorrect, GetIncorrect, getIncorrect2, GetMaxSize, getName, getPriority, GetRectangle, GetSelectedComponents, GetSelectedComponentsWithChilds, GetSelectedRectangleWithChilds, getTagValue, GetTextBrush, GetTextFormat, GetTextHorAlignment, GetVertAlignment, GetWordWrap, GrowFont, InvertComponentsPosition, isForceSerializeToReport, MakeHorizontalSpacingEqual, MakeSameHeight, MakeSameSize, MakeSameWidth, MakeVerticalSpacingEqual, MoveBackward, MoveComponentsToPage, MoveForward, Normalize, OffsetLocation, OnComponentAdded, OnComponentRemoved, PageToContainer, PageToContainer, RemoveAllSelected, ResetSelection, RestoreState, saveState, SelectAll, SelectComponent, SelectInRectangle, SelectInRectangleCheckBands, SendToBack, setBlocked, SetBorder, SetBrush, setCanBreak, SetCenterHorizontally, SetCenterVertically, setCollapsedValue, setCollapsingIndex, setCollapsingTreePath, setComponents, setComponentsFont, setComponentsFont, setComponentsWithSetParent, setComponentsWordWrap, SetConditions, setContainerInfoV2, SetDockStyle, setForceSerializeToReport, SetHorAlign, SetLink, setParentComponentIsBand, setParentComponentIsCrossBand, SetParentStylesToChilds, SetParentStylesToChilds, SetTextBrush, SetTextFormat, SetTextHorAlign, SetVertAlign, ShrinkFont, SortByPriority

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

addSize, AllowPrintOn, applyConditions, CheckForParentComponent, clearAllStates, ClearContents, ComponentToPage, ComponentToPage, ComponentToPage, convert, decrementTop, doBookmark, DoBookmark, DockToContainer, DockToContainer, doGetBookmark, DoOffsetRect, doPointer, doPointer, fillComponentPlacement, getAlias, getAllowDelete, getAnchor, getBookmarkValue, getBottom, getBuilder, getComponentPlacement, GetComponentStyle, getContainer, getCurrentBookmark, getDataBand, GetDataBand, getDelimiterComponent, getDisplayRectangle, getDisplayRectangle1, getDockable, getDockRegion, getDockRegion, getDrillDownParameters, getExpressions, getForceRedrawAll, getGroupHeaderBand, GetGroupHeaderBand, getHighlightState, getHyperlinkValue, getIgnoreNamingRule, getImage, getImage, getInherited, getInvalidateOnMouseOver, getIsCross, getIsDesigning, getIsEnabled, getIsEventEmpty, getIsExporting, getIsgetTagHandlerEmpty, getIsPrinting, getIsRendered, getIsSelected, getLevel, getLinked, getLocked, getMeasureGraphics, getPage, getPaintRectangle, getPaintRectangle, getPaintRectangle, getParent, getParentBookmark, getPlaceOnToolbox, getPointer, getPointerValue, getQuickInfo, getRenderedCount, getReport, getRestrictions, getRight, getSelectionTick, getSelectRectangle, getServiceType, getShift, getShowQuickButtons, getStates, getTagStrValue, getToolTipValue, 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, isExportAsImage, IsParentSelect, NewGuid, OnAfterPrint, OnBeforePrint, OnClick, OnDoubleClick, OngetBookmark, OngetDrillDownReport, OngetHyperlink, OngetTag, OngetToolTip, OnMouseEnter, OnMouseLeave, OnPainted, OnPainting, OnRemoveComponent, PageToComponent, PageToComponent, paint, PlacedOnColumnBand, Prepare, render, reset, Reset, restoreState, select, setAlias, setAnchor, setBookmarkValue, setClientRectangle, setComponentPlacement, setCurrentBookmark, setDelimiterComponent, setDirectDisplayRectangle, setDisplayRectangle, setDockable, setDrillDownParameters, setExpressions, setGuid, setHeightProp, setHighlightState, setHyperlinkValue, setIgnoreNamingRule, setInherited, setIsRendered, setIsSelected, setLeftProp, setLinked, setLocked, setName, setPage, setPaintRectangle, setParent, setParentBookmark, setPlaceOnToolbox, setPointer, setPointerValue, setRenderedCount, setReport, SetReportVariables, setRestrictions, setSelectionTick, setSelectRectangle, setShift, setShowQuickButtons, setStates, setTagValue, setToolTipValue, setTopProp, setWidthProp, toString, UnPrepare

Methods inherited from class com.stimulsoft.report.StiBase

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.base.serializing.interfaceobject.IStiSerializableRef

getReference, setReference

Constructor Details

StiButtonControl

public StiButtonControl()

Creates a new StiButtonControl.

StiButtonControl

public StiButtonControl(StiRectangle rect)

Creates a new StiButtonControl.

Parameters:

rect - The rectangle describes sizes and position of the control.

Method Details

getToolboxPosition

public int getToolboxPosition()

Gets value to sort a position in the toolbox.

Overrides:

getToolboxPosition in class StiReportControl

getLocalizedName

public String getLocalizedName()

Gets a localized component name.

Overrides:

getLocalizedName in class StiReportControl

getBackColor

public StiColor getBackColor()

Description copied from class: StiReportControl

Gets or sets the background color for the control.

Overrides:

getBackColor in class StiReportControl

setBackColor

public void setBackColor(StiColor value)

Overrides:

setBackColor in class StiReportControl

getImage

public final String getImage()

Gets or sets the image that is displayed on a button control.

setImage

public final void setImage(String value)

getDefault

public final boolean getDefault()

Gets or sets the value which indicates which button is clicked when the user presses the ENTER key.

setDefault

public final void setDefault(boolean value)

getDialogResult

public final StiDialogResult getDialogResult()

Gets or sets a value that is returned to the parent form when the button is clicked.

setDialogResult

public final void setDialogResult(StiDialogResult value)

getCancel

public final boolean getCancel()

Gets or sets the value which indicates which button is clicked when the user presses the ESCAPE key.

setCancel

public final void setCancel(boolean value)

getImageAlign

public final StiContentAlignment getImageAlign()

Gets or sets the alignment of the image on the button control.

setImageAlign

public final void setImageAlign(StiContentAlignment value)

getTextAlign

public final StiContentAlignment getTextAlign()

Gets or sets the alignment of the text on the button control.

setTextAlign

public final void setTextAlign(StiContentAlignment value)

getText

public final String getText()

Gets or sets the text associated with this control.

setText

public final void setText(String value)

SaveToJsonObject

public JSONObject SaveToJsonObject(StiJsonSaveMode mode)
                            throws JSONException

Specified by:

SaveToJsonObject in interface IStiJsonReportObject

Overrides:

SaveToJsonObject in class StiReportControl

Throws:

JSONException

LoadFromJsonObject

public void LoadFromJsonObject(JSONObject jObject)
                        throws JSONException

Specified by:

LoadFromJsonObject in interface IStiJsonReportObject

Overrides:

LoadFromJsonObject in class StiReportControl

Throws:

JSONException