LanerBox

Namespace: PP.TS.Ui;

Inheritance Hierarchy

 Object

Control

SourceView

PP.Mb.Ui.GridView

EaxGridView

LanerBoxView

LanerBox

Description

The LanerBox class implements the LanerBox component that shows workbook.

Syntax

PP.initClass(PP.TS.Ui.LanerBox, PP.TS.Ui.LanerBoxView, "LanerBox");

Constructor

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

Properties inherited from the LanerBoxView class

  Property name Brief description
property_image.gif EnableTabSheetActions The EnableTabSheetActions property determines whether table elements can be selected.

Methods inherited from the LanerBoxView class

  Method name Brief description
adjustSeriesSize The adjustSeriesSize method adjusts series width and height according to tab structure.
getCellHeaderText The getCellHeaderText method returns text container in the table column header for the selected cell.
getHistoryWindow The getHistoryWindow method returns a view window of point history.
getIndexOfSelectedPoints The getIndexOfSelectedPoints method returns array of indexes of the points selected in the table.
getIndexOfSelectedSeries The getIndexOfSelectedSeries method returns array of indexes for the series selected in the table.
insertSeries The insertSeries method inserts a series to the table.
isEditing The isEditing method returns whether a table is in the cell edit mode.
refreshTable The refreshTable method refreshes the selected data range.
removeSeries The removeSeries method removes series.
setDefaultWidth The setDefaultWidth method sets default width for all cells.
setNeedUpdateSelection The setNeedUpdateSelection method determines whether selection is updated after table loading.

Events inherited from the LanerBoxView class

  Event name Brief description
RequestHistory The RequestHistory event occurs on requesting value history for the specified cell in workbook table.
ShowStatDialog The ShowStatDialog event occurs on displaying the Summary Statistics dialog box.

Properties inherited from the class EaxGridView

  Property name Brief description
property_image.gif ContextMenu The ContextMenu property sets context menu for the table.
property_image.gif DeferSelectionChangedDelay The DeferSelectionChangedDelay property determines a delay before table selection change.
property_image.gif DisplayLegend The DisplayLegend property determines table legend visibility in express report working area.
property_image.gif EditMode The EditMode property determines value of the Edit Mode checkbox for express report working area table.
property_image.gif Selection The Selection property selects the specified cells in the table shown in the express report working area.
property_image.gif ShowContextButton The ShowContextButton property controls visibility of table context menu button in express report working area.
property_image.gif ShowSettingsMenuItem The ShowSettingsMenuItem property controls visibility of the Settings item in table context menu of the express report working area.
property_image.gif Source The Source property determines a table data source for the express report working area.
property_image.gif UseShiftDrillUp The UseShiftDrillUp property allows for drilling selection on level up the hierarchy on pressing the SHIFT key.
property_image.gif VisibleHeaders The VisibleHeaders property indicates whether table row and column headers are visible in the express report working area.

Methods inherited from the class EaxGridView

  Method name Brief description
sub_image.gif clearSelection The clearSelection method removes selection in the table of express report working area.
sub_image.gif fireCMenuChanged The fireCMenuChanged method handles events that occur on executing specific operations with context menu for the table of express report working area.
sub_image.gif firePropertyChanged The firePropertyChanged method handles events that occur on changing properties of OLAP cube for the table of the express report working area.
sub_image.gif getCellCoords The getCellCoords method returns coordinates of the top left corner cell in the selected range.
sub_image.gif getCellType The getCellType method returns type of the table cell by its coordinate.
sub_image.gif getChangedData The getChangedData method returns modified data in the cells of the table shown in the express report working area.
sub_image.gif getControl The getControl method returns the parent control.
sub_image.gif getFocusedCell The getFocusedCell method returns the focused table cell.
sub_image.gif getInstance The getInstance method returns an instance of the PP.Ui.TabSheet class.
sub_image.gif getLegend The getLegend method returns an interval legend object, which type corresponds with the metric type passed as a parameter.
sub_image.gif getRowsCount The getRowsCount method returns the number of rows in the table of the express report working area.
sub_image.gif getSelectionType The getSelectionType method returns type of the selected object.
sub_image.gif getTableSource The getTableSource method returns data source for the table in the express report working area.
sub_image.gif getTabSheet The getTabSheet method returns the sheet that contains table in the express report working area.
sub_image.gif getTabSheetViewMode The getTabSheetViewState method returns properties of table view in JSON format.
sub_image.gif getViewMode The getViewMode method returns value of the View Mode checkbox for express report working area table.
sub_image.gif isLoaded The isLoaded method returns whether the table in the express report working area is loaded.
sub_image.gif refresh The refresh method refreshes the specified elements of the table in the express report working area.
sub_image.gif refreshAll The refreshAll method refreshes all contents in the table of the express report working area.
sub_image.gif setCellValue The setCellValue method sets value for a cell in the table in the express report working area.
sub_image.gif setScroll The setScroll method sets scrollbars for the table in the express report working area.
sub_image.gif undo The undo method undoes the last operation executed with table in express report working area.
sub_image.gif updateLegendColumn The updateLegendColumn method refreshes the column that contains the chart legend.

Events inherited from the class EaxGridView

  Event name Brief description
event_image.gif DataChanged The DataChanged event occurs after changing data in cells of the table shown in the working area of the express report.
event_image.gif ExpanderAction The ExpanderAction event occurs on expanding an expander in the table of the express report working area.
event_image.gif HyperlinkMouseDown The HyperlinkMouseDown event occurs on clicking a hyperlink in the table of the express report working area.
event_image.gif PictureMouseDown The PictureMouseDown event occurs on clicking an icon in a cell of the table shown in the express report working area.
event_image.gif PropertyChanged The PropertyChanged event occurs after selecting an item in the context menu of the express report properties panel.
event_image.gif Rendered The Rendered event occurs after the first rendering of the table in the express report working area.
event_image.gif RequestMetadata The RequestMetadata event is generated when the table source contains no metadata.
event_image.gif SelectionChanged The SelectionChanged event occurs after changing selection in the table of the express report working area.
event_image.gif SelectionChanging The SelectionChanging event occurs in the process of changing selection in the table of the express report working area, before he user releases the mouse button.
event_image.gif StructureChanged The StructureChanged event occurs on changing the table structure: on resizing rows and columns.

Properties inherited from PP.Mb.Ui.GridView

  Property name Brief description
property_image.gif EditMode The EditMode property determines whether a table can be edited.
property_image.gif Selection The Selection property determines the current selection in a table.
property_image.gif IsAsync The IsAsync property determines whether table data asynchronous loading is used.
property_image.gif Service The Service property determines a service that is used to work with an express report.
property_image.gif SyncLoadClipboardData The SyncLoadClipboardData property determines whether data should be uploaded synchronously if there are unloaded cells on copying.
property_image.gif TableSource The TableSource property determines a table data source.

Methods inherited from PP.Mb.Ui.GridView

  Method name Brief description
sub_image.gif clearSelection

The clearSelection method clears selection in a table.

sub_image.gif getChangedData The getChangedData method returns changed data.
sub_image.gif getFocusedCell The getFocusedCell method returns coordinates of focused table cell.
sub_image.gif getInstance The getInstance method returns a table instance.
sub_image.gif getRowsCount The getRowsCount method returns the number of rows in an express report table.
sub_image.gif getSelectionType The getSelectionType method returns type of the current selection in a table.
sub_image.gif getTabSheet The getTabSheet method returns data table.
sub_image.gif setScroll The setScroll method determines visibility of horizontal and vertical scrollbars in a table.
sub_image.gif undo The undo method cancels all changes in a table.

Events inherited from PP.Mb.Ui.GridView

  Event name Brief description
event_image.gif Edited The Edited event occurs after table data is edited.
event_image.gif ExpanderAction The ExpanderAction event occurs on expanding an expander in a table.
event_image.gif HyperlinkMouseDown The HyperlinkMouseDown event occurs on clicking a hyperlink in a table.
event_image.gif PictureMouseDown The PictureMouseDown event occurs on clicking the image inside the table cell.
event_image.gif Rendered The Rendered event occurs after the table is rendered for the first time.
event_image.gif SelectionChanged The SelectionChanged event occurs after changing selection in a table.
event_image.gif SelectionChanging The SelectionChanging event occurs on changing selection in a table.
event_image.gif StructureChanged The StructureChanged event occurs after changing table structure.

Methods inherited from the class SourceView

  Method name Brief description
getSource The getSource method returns the current document of the express report.
getSrv The getSrv method returns the service that is used to work with express report.
loadFile The loadFile method loads a file with the specified name.
loadFiles The loadFiles method loads a script and style files based on table internal parameters.
refresh The refresh method refreshes specified elements of express report table.
refreshAll The refreshAll method refreshes all elements of express report table.

Events inherited from the class SourceView

   Event name Brief description
MetadataChanged The MetadataChanged event occurs on changing express report settings.
PropertyChanged The PropertyChanged event occurs after changing property value.

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