Web Dynpro API Documentation: Interface IWDMessageArea

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Web Dynpro API Documentation

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.sap.tc.webdynpro.clientserver.uielib.pattern.api
Interface IWDMessageArea

All Superinterfaces:: IWDUIElement, IWDViewElement

public interface IWDMessageArea
extends IWDUIElement

Web Dynpro MessageArea API. MessageArea is a placeholder UI element that indicates where messages (i.e. errors, warnings etc.) should be displayed. The Web Dynpro framework may choose to ignore this hint in favor of e.g. a portal mechanism for displaying messages. Use with care! If there is a suitable MessageArea instance, all messages will be displayed there. Else messages will be displayed in a window of their own (that looks like a status bar at the bottom of the screen), which is exactly the old behaviour up to Beta 4. A MessageArea is deemed suitable, if

it belongs to the layout of a view that in turn belongs to the current view assembly;
it's enabled property is neither set to false nor bound, except to a read-only context attribute of value true.
it's visibility is neither set to NONE or BLANK nor bound, except to a read-only context attribute of value VISIBLE.

If there are several suitable instances, the oldest one (with respect to creation time) is used. Note that it's the application developer's responsibility not to place a MessageArea in a view in such a way that MessageArea is not permanently visible, except if the visibility (or enabled) property of the MessageArea is set accordingly. Also beware that the tooltip property might have no effect.

This type can be called by applications using Web Dynpro, but DO NOT EXTEND OR IMPLEMENT IT!

Field Summary

static int DEFAULT_MAX_VISIBLE_MESSAGES
          Default value of property maxVisibleMessages.

Fields inherited from interface com.sap.tc.webdynpro.progmodel.api.IWDUIElement

DEFAULT_ENABLED, DEFAULT_TOOLTIP, DEFAULT_VISIBLE

Method Summary

int getMaxVisibleMessages()
          Returns the value of the maxVisibleMessages property.

void setMaxVisibleMessages(int maxVisibleMessages)
          Sets property maxVisibleMessages to the given value.

Methods inherited from interface com.sap.tc.webdynpro.progmodel.api.IWDUIElement

bindEnabled, bindEnabled, bindingOfEnabled, bindingOfTooltip, bindingOfVisible, bindTooltip, bindTooltip, bindVisible, bindVisible, createLayoutData, getContainer, getEnabled, getLayoutData, getTooltip, getVisible, setEnabled, setTooltip, setVisible

Methods inherited from interface com.sap.tc.webdynpro.progmodel.api.IWDViewElement

getId, getView, requestFocus

Field Detail

DEFAULT_MAX_VISIBLE_MESSAGES

public static final int DEFAULT_MAX_VISIBLE_MESSAGES

Default value of property maxVisibleMessages.

Method Detail

getMaxVisibleMessages

public int getMaxVisibleMessages()

Returns the value of the maxVisibleMessages property. The initial value is 0. The maximal number of messages that should be visible without scrolling; a negative or zero value means "unlimited" and displays all messages without scrolling.

Returns:: the value of the maxVisibleMessages property
See Also:: setMaxVisibleMessages(int)

setMaxVisibleMessages

public void setMaxVisibleMessages(int maxVisibleMessages)

Sets property maxVisibleMessages to the given value.

Parameters:: maxVisibleMessages - the new maxVisibleMessages value
See Also:: getMaxVisibleMessages()