StackPanel

Namespace: PP.Ui;

Inheritance Hierarchy

Object

Control

Container

StackPanel

Description

The StackPanel class implements the StackPanel component which is the container used to position items one by one in  vertical column or horizontal row.

Syntax

PP.initClass(PP.Ui.StackPanel, PP.Ui.Container, "StackPanel");

Constructor

  Constructor name Brief description
StackPanel The StackPanel constructor creates an instance of the StackPanel component.

Properties

  Property name Brief description
DeferredResize The DeferredResize property determines whether elements are resized after the mouse cursor leaves the area.
IsContentResizable The IsContentResizable property determines whether component panels can be resized.
IsHorisontal The IsHorisontal property determines whether components should be positioned vertically or horizontally.
MinControlSize The MinControlSize property determines minimum container element size.
ScrollVisible The ScrollVisible property determines whether scrollbars are visible.

Methods

  Method name Brief description
add The add method adds an element to a panel.
beginUpdate The beginUpdate method stops component rendering.
endUpdate The endUpdate method resumes component rendering.
getItemByPoint The getItemByPoint method returns container element by the specified coordinates.
sendToItems The sendToItems method calls the specified method for all elements of a component.
supportAnchors The supportAnchors method returns whether anchors are supported.

Events

   Event name Brief description
ItemSizeChanged The ItemSizeChanged event occurs after resizing the panel of the StackPanel component.
ItemSizeChanging The ItemSizeChanging event occurs after resizing the panels of the StackPanel component.

Properties inherited from the Container class

  Property name Brief description
Items The Items property sets the array of child elements of the container.

Methods inherited from the Container class

  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.

Properties inherited from the Control class

  Property name Brief description
Anchors The Anchors property determines position of the component placed within container.
Animation The Animation property sets animation parameters for component.
Bottom The Bottom property sets bottom offset on placing the component within the LayoutPanel.
Content The Content property sets the component contents.
ContextMenu The ContextMenu property sets the context menu for the component.
Data The Data property is used to store any custom data.
DataContext The DataContext property contains an object with data.
Enabled The Enabled property sets whether the component is enabled.
Height The Height property determines the component height.
IsResizable The IsResizable property determines whether the component can be resized.
IsRTL The lsRTL property sets right to left text direction.
IsVisible The IsVisible property determines whether the component is displayed.
Left The Left property sets left offset on placing the component within the GridPanel.
Offset The Offset property determines coordinates of root DOM node of a control.
Opacity The Opacity property determines component transparency.
Parent The Parent property determines a parent component of a control.
ParentNode The ParentNode property sets parent DOM node.
ResourceKey The ResourceKey property sets the resource key for the component.
Right The Right property sets right offset on placing the component within the LayoutPanel.
Rotate The Rotate property sets component rotation angle.
ShowToolTip The ShowToolTip property determines whether the tooltip of the component can be displayed.
Style The Style property sets component style.
TabIndex The TabIndex property sets the order of the control element passing inside the container.
Tag The Tag property sets JSON object associated with the component.
ToolTip The ToolTip property determines text of component tooltip.
Top The Top property sets top offset on placing the component within the GridPanel.
Value The Value property sets the value to the component.
Width The Width property sets the component width.

Methods inherited from the Control class

  Method name Brief description
The addClass method adds a CSS class to the component.
addEvent The addEvent method adds an event handler to a DOM node.
addEventHandler The addEventHandler method adds an event handler to a DOM node.
addEvents The addEvents method adds an array of event handlers to a DOM node.
The addStateClass method adds a CSS class to the component and removes the previous CSS class.
addStyleBySelector The addStyleBySelector method creates a block that contains a style with the specified CSS selector.
The addToNode method adds a component to the specified node.
bindEvents The bindEvents method subscribes an element to all available events.
The clearStylesCache method clears cache of component styles.
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.
getFunctionByName The getFunctionByName method returns function by name.
getIsBinded The getIsBinded method returns whether an element is subscribed to all DOM node events.
The hasClass method determines whether the specified CSS class is set for root DOM node of the control.
The hide method hides a control.
The hideToolTip method clears tooltip timeout and hides the tooltip if it is displayed.
The isResingNow method determines whether the component is being resized.
refreshBindingProperty The refreshBindingProperty method refreshes the bound property by name.
refreshItemsStyle The refreshItemsStyle method refreshes CSS styles of child elements.
refreshStyle The refreshStyle method refreshes element CSS styles.
The removeClass method removes CSS class from the component.
The removeEvent method removes event handler from DOM node.
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 it is possible to drag component on the HTML page.
The setFocus method sets the component focus.
The setIsHovered method displays the component as on hover.
The setIsPressed method displays the component as if clicked upon.
The setOpacityIE8 method sets component transparency value in Internet Explorer 8.
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.

Events inherited from the Control class

  Event name Brief description
Drag The Drag event occurs on clicking and holding the left 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.

Properties inherited from the class Object

  Property name Brief description
Data The Data property associates a random object with this component.
Id The Id property sets component identifier.
Settings The Settings property sets the component parameters.

Methods inherited from the class Object

  Method name Brief description
clone The clone method creates a copy of object. It is not implemented in PP.Ui.Control.
dispose The dispose method deletes the component.
getTypeName The getTypeName method returns the name of the object type without the namespace, to which it belongs.

See also:

PP.Ui