AutoRefreshMenu

Namespace: PP.Ui;

Inheritance Hierarchy

Object

Control

DropPanel

Menu

AutoRefreshMenu

Description

The AutoRefreshMenu class implements autorefresh menu.

Syntax

PP.initClass(PP.Ui.AutoRefreshMenu, PP.Ui.Menu, "PP.Ui.AutoRefreshMenu");

Constructor

  Constructor name Brief description
AutoRefreshMenu The AutoRefreshMenu constructor creates an instance of the AutoRefreshMenu class.

Properties

  Property name Brief description
Period The Period property determines parameters of periodic refresh.
ViewerUpdateSettings The ViewerUpdateSettings property determines autoupdate parameters.

Methods

  Method name Brief description
getMarkChangedItem The getMarkChangedItem method returns the menu item that sets up automatic refresh on selection change.
getPeriodDialog The getPeriodDialog method returns refresh period setup dialog box.
getPeriodicalDisableItem The getPeriodicalDisableItem method returns the menu item that disabled periodic refresh.
getPeriodicalIntervalItem The getPeriodicalIntervalItem method returns the menu item that enables periodic refresh.
setMarkChangedRefresh The setMarkChangedRefresh method enables or disables autoupdate on selection change.
setPeriodicalRefresh The setPeriodicalRefresh method enables or disables periodic refresh.
setRefresh The setRefresh method enables or disables autoupdate on selection change and periodic refresh.
startPeriodicalTimer The startPeriodicalTimer method starts periodic refresh timer.
stopPeriodicalTimer The stopPeriodicalTimer method stops periodic refresh timer.

Events

  Event name Brief description
RefreshStateChanged The RefreshStateChanged event is generated on changing autoupdate state.
RefreshTimer The RefreshTimer event is generated on working periodic refresh timer.

Properties inherited from the Menu class

  Property name Brief description

ImageList

The ImageList property sets a sprite for the menu.
Items The Items property sets an array of child items of the menu.
ScrollHeight The ScrollHeight property determines the height of the scrolled menu contents.
ShowIcons The ShowIcons property determines whether the left part of the icons menu is displayed.

Methods inherited from the Menu class

  Method name Brief description

addItem

The addItem method adds a child item of the menu.
clearCheckedByGroupName The clearCheckedByGroupName method removes selection from menu items by group name.
clearItems The clearItems method removes menu child items.
getMenuItemById The getMenuItemById method returns the child item of the menu by its identifier.
insertItem The insertItem method inserts a menu item to the specified position.
insertItemAfter The insertItemAfter method inserts a menu item after the specified item.
insertItemBefore The insertItemBefore method inserts a menu item before the specified item.
removeItem The removeItem method removes a menu item.
removeItemByIndex The removeItemByIndex method removes the menu item by index.
showContext The showContext method shows a menu as a context menu.

Event inherited from the Menu class

  Event name Brief description
ItemSelected The ItemSelected event occurs on selecting a menu item.

Properties inherited from the DropPanel class

  Property name Brief description

EnableResize

The EnableResize property determines whether the component can be resized.

EnableResizeBottom

The EnableResizeBottom property determines whether the component height can be changed by dragging its bottom border with the mouse cursor.

EnableResizeLeft

The EnableResizeLeft property determines whether the component width can be changed by dragging its left border with the mouse cursor.

EnableResizeRight

The EnableResizeRight property determines whether the component width can be changed by dragging its right border with the mouse cursor.

EnableResizeTop

The EnableResizeTop property determines whether the component height can be changed by dragging its top border with the mouse cursor.

EnableRestoreFocus

The EnableRestoreFocus property determines whether focus can be restored on closing the panel.

MaxDropDownHeight

The MinDropDownHeight property sets minimum height for a drop-down panel.

MaxDropDownWidth

The MaxDropDownWidth property sets maximum width for a drop-down panel.

MinDropDownHeight

The MinDropDownHeight property sets minimum height for a drop-down panel.

MinDropDownWidth

The MinDropDownWidth property sets minimum width for a drop-down panel.

Methods inherited from the DropPanel class

  Method name Brief description

getDroppedDown

The getDroppedDown returns whether the panel is expanded.

isVisibleArea

The isVisibleArea method determines whether the visible area includes the drop-down part.

setPosition

The setPosition method sets the position of the drop-down panel.

show

The show method expands the panel.

Events inherited from the DropPanel class

  Event name Brief description

Closed

The Closed event occurs after closing the component.

FrameDown

The FrameDown event occurs on clicking outside the panel.

Opened

The Opened event occurs after opening the component.

Opening

The Opening event occurs before opening the component.

OutOfPanelDown

The OutOfPanelDown event occurs on click outside the panel area if the panel is displayed without the support frame.

SizeChanged

The SizeChanged event occurs after resizing the component.

SizeChanging

The SizeChanging event occurs before resizing the component.

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

  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