class sap.m.CustomDynamicDateOption

Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/m/CustomDynamicDateOption
Application Component: CA-UI5-CTR

A custom option for the DynamicDateRange control.


Constructor

Constructor for a new CustomDynamicDateOption.

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.m.CustomDynamicDateOption(sId?, mSettings?)
Param Type Default Value Description
sId? string

id for the new control, generated automatically if no id is given

mSettings? object

initial settings for the new control


Properties

Name Type Default Value Description
createValueHelpUI function

Defines a method that can create the option's value help UI. For custom scenarios where getValueHelpUITypes is not enough to define the UI.

Visibility: public
enhanceFormattedValue function

Defines a method that controls whether the formatted date range should be concatenated to the formatted value when displayed.

Visibility: public
format function

Defines a method that formats the option's value to a string. See DynamicDateOption.format.

Visibility: public
getGroup function

Defines a method that provides the order index of the option's group. Used for grouping within the options list inside a DynamicDateRange's popup.

Visibility: public
getGroupHeader function

Defines a method that provides the option's group header text.

Visibility: public
getText function

Defines a method that provides the option's label text.

Visibility: public
getValueHelpOutput function

Defines a method that can collect the value from the value help UI.

Visibility: public
getValueHelpUITypes function

Defines a method that provides the option's value help UI types. Based on the types a functional value help dialog will be created. Types are DynamicDateValueHelpUIType instances.

Visibility: public
parse function

Defines a method that parses the option's value from a string. See DynamicDateOption.parse.

Visibility: public
toDates function

Defines a method that calculates an absolute date range from the options relative value. See DynamicDateOption.toDates.

Visibility: public
validateValueHelpUI function

Defines a method that can validate all controls from the value help UI related to a given option.

Visibility: public

Borrowed Properties

Name Type Default Value Description
key string

A key which identifies the option. The option produces DynamicDateRange values with operator same as the option key.

Visibility: public
valueTypes string[]

Defines the types of the option's parameters. Possible values for the array items are "date" and "int". A date range is usually represented with two consecutive "date" values.

Visibility: public

Methods Overview

Method Description
sap.m.CustomDynamicDateOption.extend

Creates a new subclass of class sap.m.CustomDynamicDateOption with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.m.DynamicDateOption.extend.

getCreateValueHelpUI

Gets current value of property createValueHelpUI.

Defines a method that can create the option's value help UI. For custom scenarios where getValueHelpUITypes is not enough to define the UI.

getEnhanceFormattedValue

Gets current value of property enhanceFormattedValue.

Defines a method that controls whether the formatted date range should be concatenated to the formatted value when displayed.

getFormat

Gets current value of property format.

Defines a method that formats the option's value to a string. See DynamicDateOption.format.

getGetGroup

Gets current value of property getGroup.

Defines a method that provides the order index of the option's group. Used for grouping within the options list inside a DynamicDateRange's popup.

getGetGroupHeader

Gets current value of property getGroupHeader.

Defines a method that provides the option's group header text.

getGetText

Gets current value of property getText.

Defines a method that provides the option's label text.

getGetValueHelpOutput

Gets current value of property getValueHelpOutput.

Defines a method that can collect the value from the value help UI.

getGetValueHelpUITypes

Gets current value of property getValueHelpUITypes.

Defines a method that provides the option's value help UI types. Based on the types a functional value help dialog will be created. Types are DynamicDateValueHelpUIType instances.

sap.m.CustomDynamicDateOption.getMetadata

Returns a metadata object for class sap.m.CustomDynamicDateOption.

getParse

Gets current value of property parse.

Defines a method that parses the option's value from a string. See DynamicDateOption.parse.

getToDates

Gets current value of property toDates.

Defines a method that calculates an absolute date range from the options relative value. See DynamicDateOption.toDates.

getValidateValueHelpUI

Gets current value of property validateValueHelpUI.

Defines a method that can validate all controls from the value help UI related to a given option.

setCreateValueHelpUI

Sets a new value for property createValueHelpUI.

Defines a method that can create the option's value help UI. For custom scenarios where getValueHelpUITypes is not enough to define the UI.

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

setEnhanceFormattedValue

Sets a new value for property enhanceFormattedValue.

Defines a method that controls whether the formatted date range should be concatenated to the formatted value when displayed.

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

setFormat

Sets a new value for property format.

Defines a method that formats the option's value to a string. See DynamicDateOption.format.

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

setGetGroup

Sets a new value for property getGroup.

Defines a method that provides the order index of the option's group. Used for grouping within the options list inside a DynamicDateRange's popup.

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

setGetGroupHeader

Sets a new value for property getGroupHeader.

Defines a method that provides the option's group header text.

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

setGetText

Sets a new value for property getText.

Defines a method that provides the option's label text.

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

setGetValueHelpOutput

Sets a new value for property getValueHelpOutput.

Defines a method that can collect the value from the value help UI.

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

setGetValueHelpUITypes

Sets a new value for property getValueHelpUITypes.

Defines a method that provides the option's value help UI types. Based on the types a functional value help dialog will be created. Types are DynamicDateValueHelpUIType instances.

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

setParse

Sets a new value for property parse.

Defines a method that parses the option's value from a string. See DynamicDateOption.parse.

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

setToDates

Sets a new value for property toDates.

Defines a method that calculates an absolute date range from the options relative value. See DynamicDateOption.toDates.

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

setValidateValueHelpUI

Sets a new value for property validateValueHelpUI.

Defines a method that can validate all controls from the value help UI related to a given option.

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

sap.m.CustomDynamicDateOption.extend

Creates a new subclass of class sap.m.CustomDynamicDateOption with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.m.DynamicDateOption.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

getCreateValueHelpUI

Gets current value of property createValueHelpUI.

Defines a method that can create the option's value help UI. For custom scenarios where getValueHelpUITypes is not enough to define the UI.

getEnhanceFormattedValue

Gets current value of property enhanceFormattedValue.

Defines a method that controls whether the formatted date range should be concatenated to the formatted value when displayed.

getFormat

Gets current value of property format.

Defines a method that formats the option's value to a string. See DynamicDateOption.format.

getGetGroup

Gets current value of property getGroup.

Defines a method that provides the order index of the option's group. Used for grouping within the options list inside a DynamicDateRange's popup.

getGetGroupHeader

Gets current value of property getGroupHeader.

Defines a method that provides the option's group header text.

getGetText

Gets current value of property getText.

Defines a method that provides the option's label text.

getGetValueHelpOutput

Gets current value of property getValueHelpOutput.

Defines a method that can collect the value from the value help UI.

getGetValueHelpUITypes

Gets current value of property getValueHelpUITypes.

Defines a method that provides the option's value help UI types. Based on the types a functional value help dialog will be created. Types are DynamicDateValueHelpUIType instances.

sap.m.CustomDynamicDateOption.getMetadata

Returns a metadata object for class sap.m.CustomDynamicDateOption.

getParse

Gets current value of property parse.

Defines a method that parses the option's value from a string. See DynamicDateOption.parse.

getToDates

Gets current value of property toDates.

Defines a method that calculates an absolute date range from the options relative value. See DynamicDateOption.toDates.

getValidateValueHelpUI

Gets current value of property validateValueHelpUI.

Defines a method that can validate all controls from the value help UI related to a given option.

setCreateValueHelpUI

Sets a new value for property createValueHelpUI.

Defines a method that can create the option's value help UI. For custom scenarios where getValueHelpUITypes is not enough to define the UI.

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

Param Type DefaultValue Description
fnCreateValueHelpUI function

New value for property createValueHelpUI

setEnhanceFormattedValue

Sets a new value for property enhanceFormattedValue.

Defines a method that controls whether the formatted date range should be concatenated to the formatted value when displayed.

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

Param Type DefaultValue Description
fnEnhanceFormattedValue function

New value for property enhanceFormattedValue

setFormat

Sets a new value for property format.

Defines a method that formats the option's value to a string. See DynamicDateOption.format.

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

Param Type DefaultValue Description
fnFormat function

New value for property format

setGetGroup

Sets a new value for property getGroup.

Defines a method that provides the order index of the option's group. Used for grouping within the options list inside a DynamicDateRange's popup.

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

Param Type DefaultValue Description
fnGetGroup function

New value for property getGroup

setGetGroupHeader

Sets a new value for property getGroupHeader.

Defines a method that provides the option's group header text.

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

Param Type DefaultValue Description
fnGetGroupHeader function

New value for property getGroupHeader

setGetText

Sets a new value for property getText.

Defines a method that provides the option's label text.

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

Param Type DefaultValue Description
fnGetText function

New value for property getText

setGetValueHelpOutput

Sets a new value for property getValueHelpOutput.

Defines a method that can collect the value from the value help UI.

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

Param Type DefaultValue Description
fnGetValueHelpOutput function

New value for property getValueHelpOutput

setGetValueHelpUITypes

Sets a new value for property getValueHelpUITypes.

Defines a method that provides the option's value help UI types. Based on the types a functional value help dialog will be created. Types are DynamicDateValueHelpUIType instances.

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

Param Type DefaultValue Description
fnGetValueHelpUITypes function

New value for property getValueHelpUITypes

setParse

Sets a new value for property parse.

Defines a method that parses the option's value from a string. See DynamicDateOption.parse.

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

Param Type DefaultValue Description
fnParse function

New value for property parse

setToDates

Sets a new value for property toDates.

Defines a method that calculates an absolute date range from the options relative value. See DynamicDateOption.toDates.

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

Param Type DefaultValue Description
fnToDates function

New value for property toDates

setValidateValueHelpUI

Sets a new value for property validateValueHelpUI.

Defines a method that can validate all controls from the value help UI related to a given option.

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

Param Type DefaultValue Description
fnValidateValueHelpUI function

New value for property validateValueHelpUI