com.sapportals.htmlb

Class MessageBar

java.lang.Object
  com.sapportals.htmlb.Component
      com.sapportals.htmlb.MessageBar

public class MessageBar

extends Component

Field Summary

static String	UI_ID
static int	VAR_BEGIN
static int	VAR_END
static int	VAR_MESSAGEBEGIN
static int	VAR_MESSAGEEND

Constructor Summary

MessageBar(String id)

Method Summary

String	getMessageText()
MessageType	getMessageType()
String	getUI() Get String identifier for this component.
boolean	isEncode() check if text should be encoded (default) or treated as native HTML.
void	renderJavascriptInterface(IPageContext renderContext, String generatedId)
boolean	requiresForm() MessageBar does not require a form and is not placed into one however, its Javascript interface is rendered with forms, therefore id generation should assume it is put into a form.
void	setEncode(boolean encode) Deprecated.
void	setMessage(MessageType type, String text) applications can use this to set the message type and text on the server
void	setMessageText(String text)
void	setMessageType(MessageType type)

Methods inherited from class com.sapportals.htmlb.Component

getEncodedIdForForm, getId, getParent, initFromPageContext, initFromShortId, initializeFromId, isJsObjectNeeded, preRender, render, renderAsString, setId, setJsObjectNeeded, setParent

Methods inherited from class java.lang.Object

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

Field Detail

VAR_BEGIN

public static final int VAR_BEGIN

See Also:

Constant Field Values

VAR_END

public static final int VAR_END

See Also:

Constant Field Values

VAR_MESSAGEBEGIN

public static final int VAR_MESSAGEBEGIN

See Also:

Constant Field Values

VAR_MESSAGEEND

public static final int VAR_MESSAGEEND

See Also:

Constant Field Values

UI_ID

public static final String UI_ID

See Also:

Constant Field Values

Constructor Detail

MessageBar

public MessageBar(String id)

Method Detail

setMessage

public void setMessage(MessageType type,
                       String text)

applications can use this to set the message type and text on the server

setMessageType

public void setMessageType(MessageType type)

setMessageText

public void setMessageText(String text)

getMessageType

public MessageType getMessageType()

getMessageText

public String getMessageText()

getUI

public String getUI()

Get String identifier for this component.

Specified by:

getUI in class Component

Returns:

a unique identification string for this Component

requiresForm

public boolean requiresForm()

MessageBar does not require a form and is not placed into one however, its Javascript interface is rendered with forms, therefore id generation should assume it is put into a form.

Overrides:

requiresForm in class Component

Returns:

false/tt>

renderJavascriptInterface

public void renderJavascriptInterface(IPageContext renderContext,
                                      String generatedId)

isEncode

public boolean isEncode()

check if text should be encoded (default) or treated as native HTML.

Returns:

true if the text should be encoded, else false

setEncode

public void setEncode(boolean encode)

Deprecated.