EaxParameterView

Namespace: PP.Exp.Ui;

Inheritance hierarchy

Object

Control

ParamView

EaxParameterView

Description

The EaxParameterView class implements view of the container for express report parameters.

Syntax

PP.initClass(PP.Exp.Ui.EaxParameterView, PP.Ui.Control, "EaxParameterView");

Constructor

  Constructor name Brief description
sub_image.gif EaxParameterView The EaxParameterView constructor creates an instance of the EaxParameterView class.

Properties

  Property name Brief description
property_image.gif ParamId The ParamId property sets identifier of an express report parameter.
property_image.gif ParamSource The ParamSource property sets an express report parameter.
property_image.gif ShowParamLabel The ShowParamLabel property controls visibility of express report parameter label.
property_image.gif Source The Source property sets data source for an express report parameter.

Methods

  Method name Brief description
sub_image.gif applyParameter The applyParameter method saves visibility setting and value determined for an express report parameter.
sub_image.gif getCurrentParamState The getCurrentParamState method returns the current (visible for the user) parameter state in metadata format.
sub_image.gif getNeedInstanceReinit The getNeedInstanceReinit method determines whether the view needs to be recreated on the next parameter refresh.
sub_image.gif getParamType The getParamType method returns parameter type.
sub_image.gif refresh The refresh method refreshes parameter on the Data Sources Parameters tab.
sub_image.gif refreshAll The refreshAll method refreshes all elements of a parameter on the Data Sources Parameters tab.
sub_image.gif setParamValue The setParamValue method sets value for an express report parameter.
sub_image.gif setParamVisible The setParamVisible method controls visibility of express report parameter.

Events

  Event name Brief description
event_image.gif LinkedDimOpened The LinkedDimOpened event occurs when the dimension linked to the parameter is successfully found and opened.
event_image.gif ParamChanged The ParamChanged event occurs on changing an express report parameter.
event_image.gif RequestLinkedDim The RequestLinkedDim event occurs before sending a request to find a dimension linked to parameter.
event_image.gif ViewReady The ViewReady event occurs when parameter view is ready for view.

Properties inherited from the class ParamView

  Property name Brief description
ParamLabel The ParamLabel property sets a label for parameter.
ShowParamLabel The ShowParamLabel property determines whether parameter label is displayed.
Source The Source property sets a source for a control.

Methods inherited from the class ParamView

  Method name Brief description
getCurrentParamState The getCurrentParamState method returns the current parameter state in metadata format.
getInstance The getInstance method returns basic control for a parameter.
getIsReady The getIsReady method determines whether parameter control is initialized.
getMetadataValue The getMetadataValue method returns metadata of report parameter control.
refresh The refresh method refreshes report parameter control.
refreshAll The refreshAll method is analog of the ParamView.refresh method.

Events inherited from the class ParamView

   Event name Brief description
LinkedDimOpened The LinkedDimOpened event occurs after getting parameter dimension.
ParamChanged The ParamChanged event occurs on changing parameter value.
ViewReady

The ViewReady event occurs after initialization of instance of the ParamView class.

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

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

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