Class sap.tnt.ToolPageModule: sap/tnt/ToolPage

extends Control

The ToolPage is a layout control, used to put together the parts of a basic tools app - ToolHeader, SideNavigation and contents area.


Since: 1.34.
Constructor Summary
new sap.tnt.ToolPage(sId?, mSettings?)Constructor for a new ToolPage.
Events borrowed from class sap.ui.core.Control
validateFieldGroup
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
Method Summary
sap.tnt.ToolPage.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.tnt.ToolPage with name sClassName and enriches it with the information contained in oClassInfo.
sap.tnt.ToolPage.getMetadata()Returns a metadata object for class sap.tnt.ToolPage.
addMainContent(oMainContent)Adds some mainContent to the aggregation mainContents.
destroyHeader()Destroys the header in the aggregation header.
destroyMainContents()Destroys all the mainContents in the aggregation mainContents.
destroySideContent()Destroys the sideContent in the aggregation sideContent.
getHeader()Gets content of aggregation header.
getMainContents()Gets content of aggregation mainContents.
getSideContent()Gets content of aggregation sideContent.
getSideExpanded()Gets current value of property sideExpanded.
indexOfMainContent(oMainContent)Checks for the provided sap.ui.core.Control in the aggregation mainContents.
insertMainContent(oMainContent, iIndex)Inserts a mainContent into the aggregation mainContents.
removeAllMainContents()Removes all the controls from the aggregation mainContents.
removeMainContent(vMainContent)Removes a mainContent from the aggregation mainContents.
setHeader(oHeader)Sets the aggregated header.
setSideContent(oSideContent)Sets the aggregated sideContent.
setSideExpanded(isSideExpanded)Sets the expand/collapse state of the SideContent.
toggleSideContentMode()Toggles the expand/collapse state of the SideContent.
Methods borrowed from class sap.ui.core.Control
addStyleClass, allowTextSelection, attachBrowserEvent, attachValidateFieldGroup, checkFieldGroupIds, clone, detachBrowserEvent, detachValidateFieldGroup, fireValidateFieldGroup, getAccessibilityInfo, getBusy, getBusyIndicatorDelay, getControlsByFieldGroupId, getFieldGroupIds, getIdForLabel, getRenderer, getVisible, hasStyleClass, invalidate, isBusy, onAfterRendering, onBeforeRendering, placeAt, removeStyleClass, rerender, setBusy, setBusyIndicatorDelay, setFieldGroupIds, setVisible, toggleStyleClass, triggerValidateFieldGroup
Methods borrowed from class sap.ui.core.Element
$, addCustomData, addDependent, addEventDelegate, applyFocusInfo, bindElement, data, destroy, destroyCustomData, destroyDependents, destroyLayoutData, destroyTooltip, enhanceAccessibilityState, exit, findElements, fireEvent, focus, getCustomData, getDependents, getDomRef, getElementBinding, getFocusDomRef, getFocusInfo, getInterface, getLayoutData, getMetadata, getTooltip, getTooltip_AsString, getTooltip_Text, indexOfCustomData, indexOfDependent, init, insertCustomData, insertDependent, prop, removeAllCustomData, removeAllDependents, removeCustomData, removeDependent, removeEventDelegate, setLayoutData, setTooltip, toString, unbindElement
Methods borrowed from class sap.ui.base.ManagedObject
addAggregation, addAssociation, applySettings, attachFormatError, attachModelContextChange, attachParseError, attachValidationError, attachValidationSuccess, bindAggregation, bindContext, bindObject, bindProperty, destroyAggregation, detachFormatError, detachModelContextChange, detachParseError, detachValidationError, detachValidationSuccess, findAggregatedObjects, fireFormatError, fireModelContextChange, fireParseError, fireValidationError, fireValidationSuccess, getAggregation, getAssociation, getBinding, getBindingContext, getBindingInfo, getBindingPath, getEventingParent, getId, getModel, getObjectBinding, getOriginInfo, getParent, getProperty, hasModel, indexOfAggregation, insertAggregation, isBound, isInvalidateSuppressed, isTreeBinding, propagateMessages, removeAggregation, removeAllAggregation, removeAllAssociation, removeAssociation, setAggregation, setAssociation, setBindingContext, setModel, setProperty, unbindAggregation, unbindContext, unbindObject, unbindProperty, validateAggregation, validateProperty
Methods borrowed from class sap.ui.base.EventProvider
attachEvent, attachEventOnce, detachEvent, hasListeners
Constructor Detail
new sap.tnt.ToolPage(sId?, mSettings?)
Constructor for a new ToolPage.

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

The supported settings are:

In addition, all settings applicable to the base type sap.ui.core.Control can be used as well.

Parameters:
{string}sId? ID for the new control, generated automatically if no id is given
{object}mSettings? Initial settings for the new control
Method Detail
sap.tnt.ToolPage.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.tnt.ToolPage 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.

Parameters:
{string}sClassName Name of the class being created
{object}oClassInfo? Object literal with information about the class
{function}FNMetaImpl? Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
Returns:
{function} Created class / constructor function
sap.tnt.ToolPage.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.tnt.ToolPage.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
addMainContent(oMainContent): sap.tnt.ToolPage
Adds some mainContent to the aggregation mainContents.
Parameters:
{sap.ui.core.Control}oMainContent the mainContent to add; if empty, nothing is inserted
Returns:
{sap.tnt.ToolPage} Reference to this in order to allow method chaining
destroyHeader(): sap.tnt.ToolPage
Destroys the header in the aggregation header.
Returns:
{sap.tnt.ToolPage} Reference to this in order to allow method chaining
destroyMainContents(): sap.tnt.ToolPage
Destroys all the mainContents in the aggregation mainContents.
Returns:
{sap.tnt.ToolPage} Reference to this in order to allow method chaining
destroySideContent(): sap.tnt.ToolPage
Destroys the sideContent in the aggregation sideContent.
Returns:
{sap.tnt.ToolPage} Reference to this in order to allow method chaining
getHeader(): sap.tnt.ToolHeader
Gets content of aggregation header.

The control to appear in the header area.

Returns:
{sap.tnt.ToolHeader}
getMainContents(): sap.ui.core.Control[]
Gets content of aggregation mainContents.

The content section.

Returns:
{sap.ui.core.Control[]}
getSideContent(): sap.tnt.SideNavigation
Gets content of aggregation sideContent.

The side menu of the layout.

Returns:
{sap.tnt.SideNavigation}
getSideExpanded(): boolean
Gets current value of property sideExpanded.

Indicates if the side area is expanded. Overrides the expanded property of the sideContent aggregation.

Default value is true.

Returns:
{boolean} Value of property sideExpanded
indexOfMainContent(oMainContent): int
Checks for the provided sap.ui.core.Control in the aggregation mainContents. and returns its index if found or -1 otherwise.
Parameters:
{sap.ui.core.Control}oMainContent The mainContent whose index is looked for
Returns:
{int} The index of the provided control in the aggregation if found, or -1 otherwise
insertMainContent(oMainContent, iIndex): sap.tnt.ToolPage
Inserts a mainContent into the aggregation mainContents.
Parameters:
{sap.ui.core.Control}oMainContent the mainContent to insert; if empty, nothing is inserted
{int}iIndex the 0-based index the mainContent should be inserted at; for a negative value of iIndex, the mainContent is inserted at position 0; for a value greater than the current size of the aggregation, the mainContent is inserted at the last position
Returns:
{sap.tnt.ToolPage} Reference to this in order to allow method chaining
removeAllMainContents(): sap.ui.core.Control[]
Removes all the controls from the aggregation mainContents.

Additionally, it unregisters them from the hosting UIArea.

Returns:
{sap.ui.core.Control[]} An array of the removed elements (might be empty)
removeMainContent(vMainContent): sap.ui.core.Control
Removes a mainContent from the aggregation mainContents.
Parameters:
{int|string|sap.ui.core.Control}vMainContent The mainContentto remove or its index or id
Returns:
{sap.ui.core.Control} The removed mainContent or null
setHeader(oHeader): sap.tnt.ToolPage
Sets the aggregated header.
Parameters:
{sap.tnt.ToolHeader}oHeader The header to set
Returns:
{sap.tnt.ToolPage} Reference to this in order to allow method chaining
setSideContent(oSideContent): sap.tnt.ToolPage
Sets the aggregated sideContent.
Parameters:
{sap.tnt.SideNavigation}oSideContent The sideContent to set
Returns:
{sap.tnt.ToolPage} Reference to this in order to allow method chaining
setSideExpanded(isSideExpanded): sap.tnt.ToolPage
Sets the expand/collapse state of the SideContent.
Parameters:
{boolean}isSideExpanded defines whether the SideNavigation is expanded.
Returns:
{sap.tnt.ToolPage} Pointer to the control instance for chaining
toggleSideContentMode(): sap.tnt.ToolPage
Toggles the expand/collapse state of the SideContent.
Returns:
{sap.tnt.ToolPage} Pointer to the control instance for chaining.