Class sap.m.ObjectMarkerModule: sap/m/ObjectMarker

extends Control

The sap.m.ObjectMarker control represents one of the following predefined types:

  • Flagged
  • Favorite
  • Draft
  • Locked
  • Unsaved Changes


Since: 1.38.
Constructor Summary
new sap.m.ObjectMarker(sId?, mSettings?)Constructor for a new ObjectMarker.
Event Summary
press(oControlEvent)Event is fired when the ObjectMarker is interactive and the user taps/clicks on it.
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.m.ObjectMarker.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.m.ObjectMarker with name sClassName and enriches it with the information contained in oClassInfo.
sap.m.ObjectMarker.getMetadata()Returns a metadata object for class sap.m.ObjectMarker.
firePress(mArguments?)Fires event press to attached listeners.
getType()Gets current value of property type.
getVisibility()Gets current value of property visibility.
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.m.ObjectMarker(sId?, mSettings?)
Constructor for a new ObjectMarker.

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
    • type : sap.m.ObjectMarkerType
    • visibility : sap.m.ObjectMarkerVisibility
  • Aggregations
    • Events
      • press : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]

    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
    Event Detail
    press(oControlEvent)
    Event is fired when the ObjectMarker is interactive and the user taps/clicks on it.
    Parameters:
    {sap.ui.base.Event}oControlEvent
    {sap.ui.base.EventProvider}oControlEvent.getSource
    {object}oControlEvent.getParameters
    Method Detail
    sap.m.ObjectMarker.extend(sClassName, oClassInfo?, FNMetaImpl?): function
    Creates a new subclass of class sap.m.ObjectMarker 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.m.ObjectMarker.getMetadata(): sap.ui.base.Metadata
    Returns a metadata object for class sap.m.ObjectMarker.
    Returns:
    {sap.ui.base.Metadata} Metadata object describing this class
    firePress(mArguments?): sap.m.ObjectMarker
    Fires event press to attached listeners.
    Parameters:
    {Map}mArguments? The arguments to pass along with the event
    Returns:
    {sap.m.ObjectMarker} Reference to this in order to allow method chaining
    getType(): sap.m.ObjectMarkerType
    Gets current value of property type.

    Sets one of the predefined types.

    Returns:
    {sap.m.ObjectMarkerType} Value of property type
    getVisibility(): sap.m.ObjectMarkerVisibility
    Gets current value of property visibility.

    Sets one of the visibility states.

    Returns:
    {sap.m.ObjectMarkerVisibility} Value of property visibility