Class sap.ui.commons.ValueHelpFieldModule: sap/ui/commons/ValueHelpField

extends TextField

A TextField with an attached icon which triggeres an event.

Deprecated API:Since version 1.38. Instead, use the sap.m.Input control.

Constructor Summary
new sap.ui.commons.ValueHelpField(sId?, mSettings?)Constructor for a new ValueHelpField.
Event Summary
valueHelpRequest(oControlEvent)Event which is fired when the ValueHelp is requested.
Events borrowed from class sap.ui.commons.TextField
change, liveChange
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.ui.commons.ValueHelpField.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.commons.ValueHelpField with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.commons.ValueHelpField.getMetadata()Returns a metadata object for class sap.ui.commons.ValueHelpField.
attachValueHelpRequest(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the valueHelpRequest event of this sap.ui.commons.ValueHelpField.
detachValueHelpRequest(fnFunction, oListener)Detaches event handler fnFunction from the valueHelpRequest event of this sap.ui.commons.ValueHelpField.
fireValueHelpRequest(mArguments?)Fires event valueHelpRequest to attached listeners.
getIconDisabledURL()Gets current value of property iconDisabledURL.
getIconHoverURL()Gets current value of property iconHoverURL.
getIconURL()Gets current value of property iconURL.
onsapshow(oEvent)Handle F4 event
setIconDisabledURL(sIconDisabledURL)Sets a new value for property iconDisabledURL.
setIconHoverURL(sIconHoverURL)Sets a new value for property iconHoverURL.
setIconURL(sIconURL)Sets a new value for property iconURL.
Methods borrowed from class sap.ui.commons.TextField
_checkChange, addAriaDescribedBy, addAriaLabelledBy, attachChange, attachLiveChange, bindValue, detachChange, detachLiveChange, fireChange, fireLiveChange, getAccessibilityInfo, getAccessibleRole, getAriaDescribedBy, getAriaLabelledBy, getDesign, getEditable, getEnabled, getFocusInfo, getHelpId, getImeMode, getInputDomRef, getLiveValue, getMaxLength, getName, getPlaceholder, getRequired, getTextAlign, getTextDirection, getValue, getValueState, getWidth, onfocusin, onkeyup, onsapenter, onsapfocusleave, onselectstart, removeAllAriaDescribedBy, removeAllAriaLabelledBy, removeAriaDescribedBy, removeAriaLabelledBy, setAccessibleRole, setDesign, setEditable, setEnabled, setHelpId, setImeMode, setMaxLength, setName, setPlaceholder, setRequired, setTextAlign, setTextDirection, setValue, setValueState, setWidth, unbindValue
Methods borrowed from class sap.ui.core.Control
addStyleClass, allowTextSelection, attachBrowserEvent, attachValidateFieldGroup, checkFieldGroupIds, clone, detachBrowserEvent, detachValidateFieldGroup, fireValidateFieldGroup, 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, 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.ui.commons.ValueHelpField(sId?, mSettings?)
Constructor for a new ValueHelpField.

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.commons.TextField 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
Deprecated:
Since version 1.38. Instead, use the sap.m.Input control.
Event Detail
valueHelpRequest(oControlEvent)
Event which is fired when the ValueHelp is requested.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
Method Detail
sap.ui.commons.ValueHelpField.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.ui.commons.ValueHelpField 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.commons.TextField.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.ui.commons.ValueHelpField.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.commons.ValueHelpField.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
attachValueHelpRequest(oData?, fnFunction, oListener?): sap.ui.commons.ValueHelpField
Attaches event handler fnFunction to the valueHelpRequest event of this sap.ui.commons.ValueHelpField.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.commons.ValueHelpField itself.

Event which is fired when the ValueHelp is requested.

Parameters:
{object}oData? An application-specific payload object that will be passed to the event handler along with the event object when firing the event
{function}fnFunction The function to be called when the event occurs
{object}oListener? Context object to call the event handler with. Defaults to this sap.ui.commons.ValueHelpField itself
Returns:
{sap.ui.commons.ValueHelpField} Reference to this in order to allow method chaining
detachValueHelpRequest(fnFunction, oListener): sap.ui.commons.ValueHelpField
Detaches event handler fnFunction from the valueHelpRequest event of this sap.ui.commons.ValueHelpField.

The passed function and listener object must match the ones used for event registration.

Parameters:
{function}fnFunction The function to be called, when the event occurs
{object}oListener Context object on which the given function had to be called
Returns:
{sap.ui.commons.ValueHelpField} Reference to this in order to allow method chaining
fireValueHelpRequest(mArguments?): sap.ui.commons.ValueHelpField
Fires event valueHelpRequest to attached listeners.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.ui.commons.ValueHelpField} Reference to this in order to allow method chaining
getIconDisabledURL(): sap.ui.core.URI
Gets current value of property iconDisabledURL.

URL of the icon for the value help when disabled. If no parameter is supplied the default icon image will be shown. If an icon font icon is used, this property is ignored.

Returns:
{sap.ui.core.URI} Value of property iconDisabledURL
getIconHoverURL(): sap.ui.core.URI
Gets current value of property iconHoverURL.

URL of the icon for the value help when hovered. If no parameter is supplied the standard icon image will be shown. If an icon font icon is used, this property is ignored.

Returns:
{sap.ui.core.URI} Value of property iconHoverURL
getIconURL(): sap.ui.core.URI
Gets current value of property iconURL.

URL of the standard icon for the value help. If no parameter is supplied the default icon image will be shown. This can be an URI to an image or an icon font URI.

Returns:
{sap.ui.core.URI} Value of property iconURL
onsapshow(oEvent)
Handle F4 event
Parameters:
{jQuery.Event}oEvent the occurring event
setIconDisabledURL(sIconDisabledURL): sap.ui.commons.ValueHelpField
Sets a new value for property iconDisabledURL.

URL of the icon for the value help when disabled. If no parameter is supplied the default icon image will be shown. If an icon font icon is used, this property is ignored.

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

Parameters:
{sap.ui.core.URI}sIconDisabledURL New value for property iconDisabledURL
Returns:
{sap.ui.commons.ValueHelpField} Reference to this in order to allow method chaining
setIconHoverURL(sIconHoverURL): sap.ui.commons.ValueHelpField
Sets a new value for property iconHoverURL.

URL of the icon for the value help when hovered. If no parameter is supplied the standard icon image will be shown. If an icon font icon is used, this property is ignored.

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

Parameters:
{sap.ui.core.URI}sIconHoverURL New value for property iconHoverURL
Returns:
{sap.ui.commons.ValueHelpField} Reference to this in order to allow method chaining
setIconURL(sIconURL): sap.ui.commons.ValueHelpField
Sets a new value for property iconURL.

URL of the standard icon for the value help. If no parameter is supplied the default icon image will be shown. This can be an URI to an image or an icon font URI.

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

Parameters:
{sap.ui.core.URI}sIconURL New value for property iconURL
Returns:
{sap.ui.commons.ValueHelpField} Reference to this in order to allow method chaining