com.sap.ui.commons.client
Class MessageBarWidget

java.lang.Object
  com.google.gwt.user.client.ui.UIObject
      com.google.gwt.user.client.ui.Widget
          com.sap.ui.core.client.ControlWidget
              com.sap.ui.commons.client.MessageBarWidget

All Implemented Interfaces:

com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.IsWidget

public class MessageBarWidget
extends com.sap.ui.core.client.ControlWidget

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: )

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

Field Summary

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

	MessageBarWidget() constructs the class MessageBarWidget
protected	MessageBarWidget(MessageBar control) constructs the class MessageBarWidget
	MessageBarWidget(String id) constructs the class MessageBarWidget

Method Summary

void	addMessages(com.sap.ui.core.client.js.JsArray<Message> aMessages) To add message(s).
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.
MessageBar	getControl() returns the reference to the Phoenix Control
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.
void	setAnchorID(String value) Setter for property anchorID
void	setAnchorSnapPoint(String value) Setter for property anchorSnapPoint Default value is: "begin top"
void	setMaxListed(int value) Setter for property maxListed Default value is: 7
void	setMaxToasted(int value) Setter for property maxToasted Default value is: 3
void	setVisible(boolean value) Setter for property visible Default value is: true

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

destroy, doAttachChildren, doDetachChildren, isDesignTime, wrap

Methods inherited from class com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onBrowserEvent, onDetach, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setWidth, sinkBitlessEvent, toString, unsinkEvents

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

MessageBarWidget

public MessageBarWidget()

constructs the class MessageBarWidget

MessageBarWidget

public MessageBarWidget(String id)

constructs the class MessageBarWidget

Parameters:

id - id of the MessageBarWidget

MessageBarWidget

protected MessageBarWidget(MessageBar control)

constructs the class MessageBarWidget

Parameters:

control - reference to an existing MessageBar

Method Detail

getControl

public MessageBar getControl()

returns the reference to the Phoenix Control

Overrides:

getControl in class com.sap.ui.core.client.ControlWidget

Returns:

reference to the Phoenix Control

getAnchorID

public 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 void setAnchorID(String value)

Setter for property anchorID

Parameters:

value - String

isVisible

public boolean isVisible()

Getter for property visible Invisible controls are not rendered.

Overrides:

isVisible in class com.google.gwt.user.client.ui.UIObject

Returns:

the value of property visible

setVisible

public void setVisible(boolean value)

Setter for property visible
Default value is: true

Overrides:

setVisible in class com.google.gwt.user.client.ui.UIObject

Parameters:

value - boolean

getMaxToasted

public 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 void setMaxToasted(int value)

Setter for property maxToasted
Default value is: 3

Parameters:

value - int

getMaxListed

public 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 void setMaxListed(int value)

Setter for property maxListed
Default value is: 7

Parameters:

value - int

getAnchorSnapPoint

public 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 void setAnchorSnapPoint(String value)

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

Parameters:

value - String

addMessages

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

To add message(s).

Parameters:

aMessages - Array of messages.

deleteMessages

public void deleteMessages(String[] ids)

To deleted messages.

Parameters:

ids - Messages IDs to be deleted.

deleteAllMessages

public void deleteAllMessages()

To deleted all messages.