com.sap.ui.commons.client
Class MessageBar

java.lang.Object
  com.google.gwt.core.client.JavaScriptObject
      com.sap.ui.core.client.Element
          com.sap.ui.core.client.Control
              com.sap.ui.commons.client.MessageBar

public class MessageBar
extends com.sap.ui.core.client.Control

The class MessageBar is the GWT wrapper for the Phoenix control: sap.ui.commons.MessageBar.

Creates an instance of a "MessageBar" Control, for displaying "Message"s. There is no imposed limit on the number of "MessageBar"s that can be created, but using only 1 makes sense, specially if accessing it (via Ctl-m) becomes a necessity.

• Properties
  • anchorID : String
    Element ID upon which the 'message bar' is to be initially positioned.
  • visible : boolean
    Invisible controls are not rendered.
  • maxToasted : int
    Maximum number of simultaneous messages being toasting-up in a row. Value '0' means this dynamic part of the feature is switched off.
  • maxListed : int
    Maximum number of messages being display in the List before a scrollbar appears. Value '0' means no limit.
  • anchorSnapPoint : String
    Type: sap.ui.core.Popup.Dock SnapPoint of MessageBar over anchorId. Note: Use "begin" or "end" for RTL support. Note: "center" is not indicated, as positioning is only set once, either via the css "left" or the "right" attribute. Therefore a MessageBar will only be extended in one direction, as Messages come in.
• Aggregations
• Associations
• Events

Version:

0.18.0-SNAPSHOT

Author:

GENERATOR (JavaScript control: sap.ui.commons.MessageBar)

Constructor Summary

protected

MessageBar() constructs the class MessageBar hidden due to JavaScriptObject restriction

Method Summary

void	addMessages(com.sap.ui.core.client.js.JsArray<Message> aMessages) To add message(s).
static MessageBar	create() creates a new instance of the class MessageBar
static MessageBar	create(String idOrConfig) creates a new instance of the class MessageBar
static MessageBar	create(String id, String config) creates a new instance of the class MessageBar
void	deleteAllMessages() To deleted all messages.
void	deleteMessages(String[] ids) To deleted messages.
String	getAnchorID() Getter for property anchorID Element ID upon which the 'message bar' is to be initially positioned.
String	getAnchorSnapPoint() Getter for property anchorSnapPoint Type: sap.ui.core.Popup.Dock SnapPoint of MessageBar over anchorId.
int	getMaxListed() Getter for property maxListed Maximum number of messages being display in the List before a scrollbar appears.
int	getMaxToasted() Getter for property maxToasted Maximum number of simultaneous messages being toasting-up in a row.
boolean	isVisible() Getter for property visible Invisible controls are not rendered.
MessageBar	setAnchorID(String value) Setter for property anchorID
MessageBar	setAnchorSnapPoint(String value) Setter for property anchorSnapPoint Default value is: "begin top"
MessageBar	setMaxListed(int value) Setter for property maxListed Default value is: 7
MessageBar	setMaxToasted(int value) Setter for property maxToasted Default value is: 3
MessageBar	setVisible(boolean value) Setter for property visible Default value is: true

Methods inherited from class com.sap.ui.core.client.Control

addStyleClass, hasStyleClass, invalidate, placeAt, placeAt, removeStyleClass, rerender

Methods inherited from class com.sap.ui.core.client.Element

_convertArray, _convertArray, _convertArray, _convertArray, _convertArray, attachBrowserEvent, attachEvent, bindAggregation, bindContext, bindProperty, bindProperty, destroy, detachBrowserEvent, detachEvent, getDomRef, getElementName, getId, getLibraryName, getModel, getParent, getProperty, getTooltip_AsString, getTooltip_Text, getTooltip, isActive, setModel, setProperty, setTooltip, setTooltip, unbindAggregation, unbindContext, unbindProperty

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

cast, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MessageBar

protected MessageBar()

constructs the class MessageBar
hidden due to JavaScriptObject restriction

Method Detail

create

public static MessageBar create()

creates a new instance of the class MessageBar

create

public static MessageBar create(String idOrConfig)

creates a new instance of the class MessageBar

Parameters:

id - id of the MessageBar or configuration JSON string

create

public static MessageBar create(String id,
                                String config)

creates a new instance of the class MessageBar

Parameters:

id - id of the MessageBar

config - configuration JSON string

getAnchorID

public final String getAnchorID()

Getter for property anchorID Element ID upon which the 'message bar' is to be initially positioned.

Returns:

the value of property anchorID

setAnchorID

public final MessageBar setAnchorID(String value)

Setter for property anchorID

Parameters:

value - String

Returns:

this to allow method chaining

isVisible

public final boolean isVisible()

Getter for property visible Invisible controls are not rendered.

Returns:

the value of property visible

setVisible

public final MessageBar setVisible(boolean value)

Setter for property visible
Default value is: true

Parameters:

value - boolean

Returns:

this to allow method chaining

getMaxToasted

public final int getMaxToasted()

Getter for property maxToasted Maximum number of simultaneous messages being toasting-up in a row. Value '0' means this dynamic part of the feature is switched off.

Returns:

the value of property maxToasted

setMaxToasted

public final MessageBar setMaxToasted(int value)

Setter for property maxToasted
Default value is: 3

Parameters:

value - int

Returns:

this to allow method chaining

getMaxListed

public final int getMaxListed()

Getter for property maxListed Maximum number of messages being display in the List before a scrollbar appears. Value '0' means no limit.

Returns:

the value of property maxListed

setMaxListed

public final MessageBar setMaxListed(int value)

Setter for property maxListed
Default value is: 7

Parameters:

value - int

Returns:

this to allow method chaining

getAnchorSnapPoint

public final String getAnchorSnapPoint()

Getter for property anchorSnapPoint Type: sap.ui.core.Popup.Dock SnapPoint of MessageBar over anchorId. Note: Use "begin" or "end" for RTL support. Note: "center" is not indicated, as positioning is only set once, either via the css "left" or the "right" attribute. Therefore a MessageBar will only be extended in one direction, as Messages come in.

Returns:

the value of property anchorSnapPoint

setAnchorSnapPoint

public final MessageBar setAnchorSnapPoint(String value)

Setter for property anchorSnapPoint
Default value is: "begin top"

Parameters:

value - String

Returns:

this to allow method chaining

addMessages

public final void addMessages(com.sap.ui.core.client.js.JsArray<Message> aMessages)

To add message(s).

Parameters:

aMessages - Array of messages.

deleteMessages

public final void deleteMessages(String[] ids)

To deleted messages.

Parameters:

ids - Messages IDs to be deleted.

deleteAllMessages

public final void deleteAllMessages()

To deleted all messages.