The LegendContainer control uses the NavContainer control to handle hierarchical navigation between legend sections. The LegendContainer control contains an initial navigation page. Both the initial navigation page legend sections are Page controls.
Method Summary
sap.gantt.legend.LegendContainer.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.gantt.legend.LegendContainer with name sClassName and enriches it with the information contained in oClassInfo. addLegendSection(oLegendSection)Adds some legendSection to the aggregation legendSections. getHeight()Gets current value of property height. getNavigationPage()Returns the control instance of List Control for the initial navigation page getWidth()Gets current value of property width. indexOfLegendSection(oLegendSection)Checks for the provided sap.m.Page in the aggregation legendSections. insertLegendSection(oLegendSection, iIndex)Inserts a legendSection into the aggregation legendSections. removeLegendSection(vLegendSection)Removes a legendSection from the aggregation legendSections. setHeight(sHeight)Sets a new value for property height. setWidth(sWidth)Sets a new value for property width. 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 $,
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,
insertCustomData,
insertDependent,
prop,
removeAllCustomData,
removeAllDependents,
removeCustomData,
removeDependent,
removeEventDelegate,
setLayoutData,
setTooltip,
toString,
unbindElement 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 Constructor Detail
new sap.gantt.legend.LegendContainer(sId?, mSettings?)
Creates and initializes a new legend container.
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:
- Properties
- width : sap.ui.core.CSSSize (default: 200px)
- height : sap.ui.core.CSSSize (default: 200px)
- Aggregations
In addition, all settings applicable to the base type sap.ui.core.Control can be used as well.
Parameters:
| {string} | sId? | ID of the new control, generated automatically if no ID is given |
| {object} | mSettings? | Initial settings for the new control |
Method Detail
sap.gantt.legend.LegendContainer.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.gantt.legend.LegendContainer 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 |
Returns a metadata object for class sap.gantt.legend.LegendContainer.
Returns:
Adds some legendSection to the aggregation legendSections.
Parameters:
| {sap.m.Page} | oLegendSection | the legendSection to add; if empty, nothing is inserted |
Returns:
Destroys all the legendSections in the aggregation legendSections.
Returns:
Returns the currently displayed legend section. If no legend section is added, this function returns the initial navigation page.
Returns:
| {sap.m.Page} | Control instance of the legend section |
Gets current value of property
height.
Height of the legend navigation. When the height specified is smaller than a section content, a vertical scroll bar appears.
Default value is 200px.
Returns:
Gets content of aggregation
legendSections.
This aggregation specifies the title of a legend section. When you add the legend section to a legend navigation container, you must specify a title for the legend section so that the section can be identified in the initial navigation list. Otherwise, your legend section is not reachable via GUI.
Returns:
Returns the navigation items in the initial navigation list
Returns:
Returns the control instance of List Control for the initial navigation page
Returns:
| {sap.m.Page} | Control instance of the initial navigation page |
Gets current value of property
width.
Width of the legend navigation. When the width specified is smaller than a section content, a horizontal scroll bar appears.width of the legend navigation. When the width specified is smaller than a section content, a horizontal scroll bar appears.
Default value is 200px.
Returns:
indexOfLegendSection(oLegendSection): int
Checks for the provided sap.m.Page in the aggregation legendSections. and returns its index if found or -1 otherwise.
Parameters:
| {sap.m.Page} | oLegendSection | The legendSection whose index is looked for |
Returns:
| {int} | The index of the provided control in the aggregation if found, or -1 otherwise |
Inserts a legendSection into the aggregation legendSections.
Parameters:
| {sap.m.Page} | oLegendSection | the legendSection to insert; if empty, nothing is inserted |
| {int} | iIndex | the 0-based index the legendSection should be inserted at; for a negative value of iIndex, the legendSection is inserted at position 0; for a value greater than the current size of the aggregation, the legendSection is inserted at the last position |
Returns:
Removes all the controls from the aggregation
legendSections.
Additionally, it unregisters them from the hosting UIArea.
Returns:
| {sap.m.Page[]} | An array of the removed elements (might be empty) |
Removes a legendSection from the aggregation legendSections.
Parameters:
| {int|string|sap.m.Page} | vLegendSection | The legendSectionto remove or its index or id |
Returns:
Sets a new value for property
height.
Height of the legend navigation. When the height specified is smaller than a section content, a vertical scroll bar appears.
When called with a value of null or undefined, the default value of the property will be restored.
Default value is 200px.
Parameters:
Returns:
Sets a new value for property
width.
Width of the legend navigation. When the width specified is smaller than a section content, a horizontal scroll bar appears.width of the legend navigation. When the width specified is smaller than a section content, a horizontal scroll bar appears.
When called with a value of null or undefined, the default value of the property will be restored.
Default value is 200px.
Parameters:
Returns: