MetabaseObjectsView

Namespace: PP.Mb.Ui;

Inheritance Hierarchy

Object

Control

ProxyControl

MetabaseObjectsView

Description

The MetabaseObjectsView class implements a base class for displaying a list of repository objects.

Comments

The class is parent for the classes:

Syntax

PP.initClass(PP.Mb.Ui.MetabaseObjectsIconView, ProxyControl, "MetabaseObjectsIconView");

Constructor

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

Properties

  Property name Brief description
CustomClasses The CustomClasses property contains an array of object custom classes.
DisplayMode The DisplayMode property determines display mode for repository object names.
EditOnLoad The EditOnLoad property determines an object key that should be renamed on loading.
Filter The Filter property determines a list of objects that will be displayed in component.
FolderTreeFilter The FolderTreeFilter property determines filter for containers.
Metabase The Metabase property determines a repository that provides data for component.
MultiSelect The MultiSelect property determines whether multiple selection is available.
RootKey The RootKey property determines a root object, which objects are displayed in component.
SelectedKeys The SelectedKeys property contains an array of selected object keys.
ShowEmptyFolder The ShowEmptyFolder property determines whether empty folders are displayed.
ShowOnlyContainers The ShowOnlyContainers property determines a mode for displaying only containers.

Methods

  Method name Brief description
addObject The addObject method adds a repository object to component.
beginUpdate The beginUpdate method disables rendering of the component used for object displaying.
clear The clear method clears a list of all objects.
deleteObject The addObject method removes an object from the display list.
editObject The editObject method enables edit mode for an object.
endUpdate The endUpdate method enables again rerendering of the object used for object displaying.
getAllNodesLoaded The getAllNodesLoaded method returns whether all nodes are loaded.
getCustomClassObject The getCustomClassObject method returns object custom class.
getFocusedObject The getFocusedObject method returns focused repository object.
getImageList The getImageList method returns sprite object.
getObjects The getObjects method returns all repository objects.
getSelectedObjects The getSelectedObjects method returns selected repository objects.
loadFrom The loadFrom method clears a component and loads only specified objects.
refresh The refresh method refreshes status of the specified object in component.
refreshAll The refreshAll method refreshes status of all objects in component.
removeFocus The removeFocus method removes the current focus.

Method inherited from the class ProxyControl

  Method name Brief description
getControl The getControl method returns the basic control that inherits from PP.Ui.Control.

Properties inherited from the class Control

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

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

  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

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