class sap.ui.vtm.SelectColumnsDialog

Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/vtm/SelectColumnsDialog
Application Component:

A dialog used to select the columns to display in a sap.ui.vtm.Tree.


Constructor

Constructor for a new SelectColumnsDialog.

Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject#constructor for a general description of the syntax of the settings object.

new sap.ui.vtm.SelectColumnsDialog()

Properties

Name Type Default Value Description
selectableColumns sap.ui.vtm.Column[]

The set of columns that should be shown in the dialog that may be selected for display.

Visibility: public
tree object

The sap.ui.vtm.Tree that column selection is being performed for.

Visibility: public

Methods Overview

Method Description
sap.ui.vtm.SelectColumnsDialog.extend

Creates a new subclass of class sap.ui.vtm.SelectColumnsDialog with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.core.Control.extend.

sap.ui.vtm.SelectColumnsDialog.getMetadata

Returns a metadata object for class sap.ui.vtm.SelectColumnsDialog.

getSelectableColumns

Gets current value of property selectableColumns.

The set of columns that should be shown in the dialog that may be selected for display.

getTree

Gets current value of property tree.

The sap.ui.vtm.Tree that column selection is being performed for.

open

Opens the dialog. The dialog applies the updated set of columns to the tree if confirmed.

setSelectableColumns

Sets a new value for property selectableColumns.

The set of columns that should be shown in the dialog that may be selected for display.

When called with a value of null or undefined, the default value of the property will be restored.

setTree

Sets a new value for property tree.

The sap.ui.vtm.Tree that column selection is being performed for.

When called with a value of null or undefined, the default value of the property will be restored.

sap.ui.vtm.SelectColumnsDialog.extend

Creates a new subclass of class sap.ui.vtm.SelectColumnsDialog with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.core.Control.extend.

Param Type DefaultValue Description
sClassName string

Name of the class being created

oClassInfo object

Object literal with information about the class

FNMetaImpl function

Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class

sap.ui.vtm.SelectColumnsDialog.getMetadata

Returns a metadata object for class sap.ui.vtm.SelectColumnsDialog.

getSelectableColumns

Gets current value of property selectableColumns.

The set of columns that should be shown in the dialog that may be selected for display.

getTree

Gets current value of property tree.

The sap.ui.vtm.Tree that column selection is being performed for.

open

Opens the dialog. The dialog applies the updated set of columns to the tree if confirmed.

setSelectableColumns

Sets a new value for property selectableColumns.

The set of columns that should be shown in the dialog that may be selected for display.

When called with a value of null or undefined, the default value of the property will be restored.

Param Type DefaultValue Description
sSelectableColumns sap.ui.vtm.Column[]

New value for property selectableColumns

setTree

Sets a new value for property tree.

The sap.ui.vtm.Tree that column selection is being performed for.

When called with a value of null or undefined, the default value of the property will be restored.

Param Type DefaultValue Description
oTree object

New value for property tree