The Spoiler component is a drop-down panel with items.
The component is implemented by the Spoiler class.
The component looks as follows:
The example of creating the panel is described in the Example of Creating the Spoiler Component page.
Constructor name | Brief description | |
Spoiler | The Spoiler constructor creates an instance of the Spoiler property. |
Property name | Brief description | |
DefaultContentMargin | The DefaultContentMargin property determines panel contents margin. | |
DefaultResizerSize | The DefaultResizerSize property determines minimum panel contents margin. | |
EnableCollapse | The EnableCollapse property determines whether the panel can be collapsed. | |
EnableResize | The EnableResize property determines whether the panel can be resized. | |
IsExpanded | The IsExpanded property determines panel state. | |
MaxPanelSize | The MaxPanelSize property determines maximum panel size. | |
MinPanelSize | The MinPanelSize property determines minimum panel size. | |
Position | The Position property determines panel collapsing direction. | |
Title | The Title property determines the panel text displayed when the panel is collapsed. |
Event name | Brief description | |
Collapsed | The Collapsed event occurs after collapsing a panel. | |
Expanded | The Expanded event occurs after expanding a panel. | |
Resized | The Resized event occurs after resizing a panel. | |
Resizing | The Resizing event occurs on resizing a panel. |
Property name | Brief description | |
IsAbsolutePositioning | The IsAbsolutePositioning property determines panel elements position. | |
Name | The Name property returns panel name. |
Method name | Brief description | |
add | The add method adds an element to a panel. | |
beginUpdate | The beginUpdate method disables refreshing of the panel until the endUpdate method is called. | |
endUpdate | The endUpdate method enables panel rerendering and refreshes it. | |
getContentNode | The getContentNode method returns the DOM node for the panel contents. | |
getItemByPoint | The getItemByPoint method returns panel element by the specified coordinates. | |
supportAnchors | The supportAnchors method returns whether Anchors are used in the panel. | |
toBack | The toBack method sends the element to back. | |
toFront | The toFront method brings the element to front. |
Property name | Brief description | |
Items | The Items property sets the array of child elements of the container. |
Method name | Brief description | |
clear | The clear method removes a component from the HTML page. | |
contains | The contains method checks if an element is in the container. | |
forEachElement | The forEachElement method applies the function to all container elements. | |
getCount | The getCount method returns the number of child elements of the container. | |
getItem | The getItem method removes the child element of the container by its index. | |
getItemById | The getItemById method returns the child element of the container by its identifier. | |
getLayoutItems | The getLayoutItems method returns an array of table panels. | |
hideAt | The hideAt method hides the child element of the container by its index. | |
remove | The remove method removes the selected child element of the container. | |
removeAt | The removeAt method removes the child element of the container by its index. | |
setSettingsToControls | The setSettingsToControls method sets general settings for the child elements of the container. | |
showAt | The showAt method displays the child element of the container by its index. |
Property name | Brief description | |
Anchors | The Anchors property determines position of the component placed within container. | |
Animation | The Animation property determines component animation parameters. | |
Bottom | The Bottom property determines a bottom margin if a component is placed inside LayoutPanel. | |
Content | The Content property determines component contents. | |
ContextMenu | The ContextMenu property determines a component's context menu. | |
Data | The Data property is used to store any custom data. | |
Enabled | The Enabled property determines whether a component can be used. | |
Height | The Height property determines component height. | |
IsRTL | The IsRTL property determines whether component elements are aligned to the right. | |
IsVisible | The IsVisible property determines whether a component is displayed. | |
Left | The Left property determines a left margin if a component is placed inside GridPanel. | |
Opacity | The Opacity property determines component transparency. | |
Parent | The Parent property determines a parent component of a control. | |
ParentNode | The ParentNode property determines a parent DOM node. | |
ResourceKey | The ResourceKey property determines a component resource key. | |
Right | The Right property determines a right margin if a component is placed inside LayoutPanel. | |
Rotate | The Rotate property determines a component rotation angle. | |
ShowToolTip | The ShowToolTip property determines whether a tooltip of the component can be displayed. | |
Style | The Style property determines a component style. | |
TabIndex | The TabIndex property determines the order of the control element passing inside the container. | |
Tag | The Tag property determines a JSON object associated with the component. | |
ToolTip | The ToolTip property determines text of component tooltip. | |
Top | The Top property determines a top margin if a component is placed inside GridPanel. | |
Value | The Value property determines a component value. | |
Width | The Width property determines component width. |
Method name | Brief description | |
The addClass method adds a CSS class to the component. | ||
addEventHandler | The addEventHandler method adds an event handler to a DOM node. | |
The addStateClass method adds a CSS class to the component and removes the previous CSS class. | ||
The addToNode method adds a component to the specified node. | ||
bindEvents | The bindEvents method subscribes an element to all available events. | |
The getAnchorFlags method returns JSON object that contains settings of the current component's position. | ||
The getClass method returns the current CSS classes of the component. | ||
The getCssStyle method returns style for the specified node. | ||
The getDomNode method returns main DOM node of the component. | ||
The getFocused method determines whether the component is focused. | ||
getIsBinded | The getIsBinded method returns whether an element is subscribed to all DOM node events. | |
The hide method hides a control. | ||
The hideToolTip method clears tooltip timeout and hides the tooltip if it is shown. | ||
refreshStyle | The refreshStyle method refreshes element CSS styles. | |
The removeClass method removes CSS class from the component. | ||
removeEventHandler | The removeEventHandler method removes event handler from DOM node. | |
removeFromDOM | The removeFromDOM method removes node from the DOM structure. | |
The removeStateClasses method removes CSS classes of the component. | ||
The setDraggable method determines whether a component can be dragged on the HTML page. | ||
The setFocus method sets the component focus. | ||
The setIsHovered method sets up component displaying only on mouseover. | ||
The setSize method establishes the sizes of the component. | ||
The show method displays a control. | ||
unBindEvents | The unBindEvents method unsubscribes an element from all standard events. | |
The updatePosition method updates size and position when absolute positioning based on the current parameters is used. | ||
The updateSize method updates the component size on changing the size of the container that contains the component. |
Event name | Brief description | |
Drag | The Drag event occurs on clicking and holding the mouse button. | |
DragEnd | The DragEnd event occurs when dragging the component finishes. | |
DragStart | The DragStart event occurs when dragging the component starts. | |
OnContextMenu | The OnContextMenu event occurs on calling context menu of the component. | |
SizeChanged | The SizeChanged event occurs after the component is resized. | |
SizeChanging | The SizeChanging event occurs during component resize. |
Property name | Brief description | |
The Id property determines a repository object identifier. |
Method name | Brief description | |
clone | The clone method creates an object copy. | |
dispose | The dispose method deletes the component. | |
getHashCode | The getHashCode method returns hash code of repository object. | |
getId | The getId method returns repository object identifier. | |
getSettings | The getSettings method returns repository object settings. | |
getTypeName | The getTypeName method returns the name of the object type without the namespace, to which it belongs. | |
isEqual | The isEqual method determines whether the specified object is equal to the current repository object. | |
isLive | The isLive method determines validity of repository object. | |
removeAllEvents | The removeAllEvents method removes all object event handlers by the specified context. | |
setId | The setId method determines a repository object identifier. | |
setSettings | The setSettings method determines repository object settings. | |
defineProps | The defineProps method creates get and set methods from name array for the specified class. | |
keys | The keys method returns array of methods and properties names for the specified object. |
See also: