com.stimulsoft.report.dialogs

Class StiCheckedListBoxControl

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.StiCheckedListBoxControl

All Implemented Interfaces:

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

public class StiCheckedListBoxControl
extends StiReportControl

Displays a ListBox in which a check box is displayed to the left of each item.

Field Summary

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

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

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

canGrow, canShrink, componentPlacement, conditions, interaction, isRendered, page, parent, parentBookmark, 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 and Description
StiCheckedListBoxControl() Creates a new StiCheckedListBoxControl.
StiCheckedListBoxControl(StiRectangle rect) Creates a new StiCheckedListBoxControl.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object[]	getCheckedItems() Collection of checked items in this CheckedListBox.
boolean	getCheckOnClick() Gets or sets a value indicating whether the check box should be toggled when an item is selected.
StiRectangle	getDefaultClientRectangle() Gets or sets the default client area of a component.
StiEvent	GetDefaultEvent() Gets default event for this report control.
StiEventsCollection	getEvents() Return events collection of this component;
StiColor	getForeColor() Gets or sets the foreground color of the control.
int	getItemHeight() Gets the height of the item area.
java.util.ArrayList	getItems() Gets the collection of items in this CheckedListBox.
java.lang.String	getItemsBinding() Gets the data bindings for the items.
java.lang.String	getLocalizedName() Gets a localized component name.
int	getSelectedIndex() Gets or sets the zero-based index of the currently selected item in a ListBox.
java.lang.String	getSelectedIndexBinding() Gets the data bindings for the selected index.
StiSelectedIndexChangedEvent	getSelectedIndexChangedEvent() Occurs when the SelectedIndex property has changed.
java.lang.Object	getSelectedItem() Gets or sets the currently selected item in the ListBox.
java.lang.String	getSelectedItemBinding() Gets the data bindings for the selected item.
java.lang.Object	getSelectedValue() Gets or sets the value of the member property specified by the ValueMember property.
java.lang.String	getSelectedValueBinding() Gets the data bindings for the selected value.
boolean	getSorted() Gets or sets a value indicating whether the items in the ListBox are sorted alphabetically.
int	getToolboxPosition() Gets value to sort a position in the toolbox.
void	LoadFromJsonObject(JSONObject jObject)
JSONObject	SaveToJsonObject(StiJsonSaveMode mode)
void	setCheckedItems(java.lang.Object[] value)
void	setCheckOnClick(boolean value)
void	setForeColor(StiColor value)
void	setItemHeight(int value)
void	setItems(java.util.ArrayList value)
void	setItemsBinding(java.lang.String value)
void	setSelectedIndex(int value)
void	setSelectedIndexBinding(java.lang.String value)
void	setSelectedIndexChangedEvent(StiSelectedIndexChangedEvent value)
void	setSelectedItem(java.lang.Object value)
void	setSelectedItemBinding(java.lang.String value)
void	setSelectedValue(java.lang.Object value)
void	setSelectedValueBinding(java.lang.String value)
void	setSorted(boolean value)

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

canContainIn, clone, convert, getAfterPrintEvent, getBackColor, getBeforePrintEvent, getBookmark, getBorder, getBrush, getCanGrow, getCanShrink, getClickEvent, getComponentStyle, getConditions, getControlWpf, getDockStyle, getDoubleClickEvent, getEnabled, getEnterEvent, getFont, 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, setBackColor, setBeforePrintEvent, setBookmark, setBorder, setBrush, setCanGrow, setCanShrink, setClickEvent, setComponentStyle, setConditions, setControlWpf, setDockStyle, setDoubleClickEvent, setEnabled, setEnterEvent, setFont, 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, fillComponentPlacement, getAlias, getAllowDelete, getAnchor, getBookmarkValue, getBottom, getBuilder, getComponentPlacement, getContainer, getCurrentBookmark, getDataBand, GetDataBand, getDelimiterComponent, getDisplayRectangle, getDisplayRectangle1, getDockable, getDockRegion, getDockRegion, getDrillDownParameters, 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, getQuickInfo, getRenderedCount, getReport, getRestrictions, getRight, getSelectionTick, getSelectRectangle, getServiceType, getShift, getShowQuickButtons, getStates, getToolTipValue, incrementtTop, InternalRender, invert, InvokeAfterPrint, InvokeBeforePrint, InvokeBeginRender, InvokeClick, InvokeDoubleClick, InvokeEndRender, invokeEvents, InvokegetBookmark, InvokegetDrillDownReport, InvokegetHyperlink, InvokegetTag, InvokegetToolTip, InvokeMouseEnter, InvokeMouseLeave, InvokePainted, invokePainting, 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, setGuid, setHeightProp, setHighlightState, setHyperlinkValue, setIgnoreNamingRule, setInherited, setIsRendered, setIsSelected, setLeftProp, setLinked, setLocked, setName, setPage, setPaintRectangle, setParent, setParentBookmark, setPlaceOnToolbox, 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 Detail

StiCheckedListBoxControl

public StiCheckedListBoxControl()

Creates a new StiCheckedListBoxControl.

StiCheckedListBoxControl

public StiCheckedListBoxControl(StiRectangle rect)

Creates a new StiCheckedListBoxControl.

Parameters:

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

Method Detail

getEvents

public StiEventsCollection getEvents()

Return events collection of this component;

Overrides:

getEvents in class StiReportControl

getToolboxPosition

public int getToolboxPosition()

Gets value to sort a position in the toolbox.

Overrides:

getToolboxPosition in class StiReportControl

getLocalizedName

public java.lang.String getLocalizedName()

Gets a localized component name.

Overrides:

getLocalizedName in class StiReportControl

getSelectedIndexChangedEvent

public StiSelectedIndexChangedEvent getSelectedIndexChangedEvent()

Occurs when the SelectedIndex property has changed.

setSelectedIndexChangedEvent

public void setSelectedIndexChangedEvent(StiSelectedIndexChangedEvent value)

getItemsBinding

public final java.lang.String getItemsBinding()

Gets the data bindings for the items.

setItemsBinding

public final void setItemsBinding(java.lang.String value)

getSelectedItemBinding

public final java.lang.String getSelectedItemBinding()

Gets the data bindings for the selected item.

setSelectedItemBinding

public final void setSelectedItemBinding(java.lang.String value)

getSelectedValueBinding

public final java.lang.String getSelectedValueBinding()

Gets the data bindings for the selected value.

setSelectedValueBinding

public final void setSelectedValueBinding(java.lang.String value)

getSelectedIndexBinding

public final java.lang.String getSelectedIndexBinding()

Gets the data bindings for the selected index.

setSelectedIndexBinding

public final void setSelectedIndexBinding(java.lang.String value)

getForeColor

public StiColor getForeColor()

Description copied from class: StiReportControl

Gets or sets the foreground color of the control.

Overrides:

getForeColor in class StiReportControl

setForeColor

public void setForeColor(StiColor value)

Overrides:

setForeColor in class StiReportControl

getItems

public java.util.ArrayList getItems()

Gets the collection of items in this CheckedListBox.

setItems

public void setItems(java.util.ArrayList value)

getItemHeight

public int getItemHeight()

Gets the height of the item area.

setItemHeight

public void setItemHeight(int value)

getSelectedIndex

public int getSelectedIndex()

Gets or sets the zero-based index of the currently selected item in a ListBox.

setSelectedIndex

public void setSelectedIndex(int value)

getSelectedItem

public java.lang.Object getSelectedItem()

Gets or sets the currently selected item in the ListBox.

setSelectedItem

public void setSelectedItem(java.lang.Object value)

getSelectedValue

public java.lang.Object getSelectedValue()

Gets or sets the value of the member property specified by the ValueMember property.

setSelectedValue

public void setSelectedValue(java.lang.Object value)

getCheckedItems

public java.lang.Object[] getCheckedItems()

Collection of checked items in this CheckedListBox.

setCheckedItems

public void setCheckedItems(java.lang.Object[] value)

getSorted

public boolean getSorted()

Gets or sets a value indicating whether the items in the ListBox are sorted alphabetically.

setSorted

public void setSorted(boolean value)

getCheckOnClick

public boolean getCheckOnClick()

Gets or sets a value indicating whether the check box should be toggled when an item is selected.

setCheckOnClick

public void setCheckOnClick(boolean value)

GetDefaultEvent

public StiEvent GetDefaultEvent()

Gets default event for this report control.

Specified by:

GetDefaultEvent in interface IStiReportControl

Overrides:

GetDefaultEvent in class StiReportControl

Returns:

Default event.

getDefaultClientRectangle

public StiRectangle getDefaultClientRectangle()

Gets or sets the default client area of a component.

Overrides:

getDefaultClientRectangle in class StiReportControl

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