SlidePanel

Namespace: PP.Ui;

Inheritance Hierarchy

Object

Control

SlidePanel

Description

The SlidePanel class implements the SlidePanel component; that is a control consisting of three linked panels: Header, Details, and View.

Syntax

PP.initClass(PP.Ui.SlidePanel, PP.Ui.Control, "SlidePanel");

Constructor

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

Properties

  Property name Brief description
Alignment The Alignment property sets console alignment relative to the panel center.
CloseToolTip The CloseToolTip property sets text of tooltip for the button that closes the console.
CollapseConsoleToolTip The CollapseConsoleToolTip property sets text of tooltip for the button that collapses the console.
DetailsContent The DetailsContent property sets contents for the Details panel.
DetailsTitleContent The DetailsTitleContent property sets text for the Details panel title.
DetailsTitleHeight The DetailsTitleHeight property sets height for the Details panel title.
EnableResize The EnableResize property determines whether the Header and Details panels can be resized.
ExpandConsoleToolTip The ExpandConsoleToolTip property sets a tooltip for the button, clicking which expands the console.
HeaderContent The HeaderContent property sets contents of the Header panel.
HeaderToolTip The HeaderToolTip property sets a tooltip for the title panel.
IsConsoleClosable The IsConsoleClosable property determines whether the button that closes the console is displayed.
IsConsoleClosed The IsConsoleClosed property determines whether the console is closed.
IsConsoleCollapsed The IsConsoleCollapsed property determined whether the console is collapsed.
IsConsoleExpandable The IsConsoleExpandable property determines whether the button that collapses the console is displayed.
LeftPanelWidth The LeftPanelWidth property sets console (left panel) width.
MinLeftPanelWidth The MinLeftPanelWidth property determines minimum width of the Header and Details panels.
ViewContent The ViewContent property sets contents for the View panel.

Methods

  Method name Brief description
getButtonsPanelDomNode The getButtonsPanelDomNode method returns the DOM node that contains buttons that are used to close, collapse and expand the console.
getConsoleCollapsedWidth The getConsoleCollapsedWidth method returns distance value between contents and headers of the Details panel.
getHeaderHeight The getHeaderHeight method returns height of the title bar.
getViewHeight The getViewHeight method returns height of the View panel.
getViewWidth The getViewWidth method returns width of the View panel.

Events

   Event name Brief description
ConsoleClosed The ConsoleClosed event occurs on closing the console.
ConsoleOpened The ConsoleOpened event occurs on opening the console.
ConsoleToggled The ConsoleToggled event occurs after collapsing or expanding the console.
Resized The Resized event occurs after resizing the Details panel.
Resizing The Resizing event occurs on resizing the Details panel.

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

Methods inherited from the Control class

  Method name Brief description

addClass

The addClass method adds a CSS class to the component.
addEventHandler The addEventHandler method adds an event handler to a DOM node.

addStateClass

The addStateClass method adds a CSS class to the component and removes the previous CSS class.

addToNode

The addToNode method adds a component to the specified node.
bindEvents The bindEvents method subscribes an element to all available events.

getAnchorFlags

The getAnchorFlags method returns JSON object that contains settings of the current component's position.

getClass

The getClass method returns the current CSS classes of the component.

getCssStyle

The getCssStyle method returns style for the specified node.

getDomNode

The getDomNode method returns main DOM node of the component.

getFocused

The getFocused method determines whether the component is focused.
getIsBinded The getIsBinded method returns whether an element is subscribed to all DOM node events.

hide

The hide method hides a control.

hideToolTip

The hideToolTip method clears tooltip timeout and hides the tooltip if it is shown.
refreshStyle The refreshStyle method refreshes element CSS styles.

removeClass

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.

removeStateClasses

The removeStateClasses method removes CSS classes of the component.

setDraggable

The setDraggable method determines whether a component can be dragged on the HTML page.

setFocus

The setFocus method sets the component focus.

setIsHovered

The setIsHovered method sets up component displaying only on mouseover.

setSize

The setSize method establishes the sizes of the component.

show

The show method displays a control.
unBindEvents The unBindEvents method unsubscribes an element from all standard events.

updatePosition

The updatePosition method updates size and position when absolute positioning based on the current parameters is used.

updateSize

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

Id

The Id property determines a repository object identifier.

Methods inherited from the Control class

  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:

PP.Ui