Web Dynpro MessageArea API – IWDMessageArea 

Definition

The MessageArea UI element represents a placeholder that specifies where messages, such as error messages or warnings, should appear in the view.

If there is a suitable MessageArea instance, all messages appear in this instance. Otherwise, the messages appear in a separate window that is similar to a status bar and appears at the bottom of the screen. You can use a MessageArea instance when it belongs to the layout of the associated view.

You cannot set the enabled property to the value false and can only bind this property to a read-only context attribute of type boolean with the value true.

You cannot set the visible property to the values none or blank and can only bind this property to a read-only context attribute of type com.sap.ide.webdynpro.uielementdefinitions.Visibility with the value “VISIBLE“.

If there is more than one suitable IWDMessageAreainstance, the first instance created is used.

Under certain circumstances, the Web Dynpro Framework changes the position specification of the MessageArea UI elements, if other targets have priority, for example, portal mechanisms for displaying error messages.

If the MessageArea UI element should be visible, make sure that the view that contains the UI element is also visible, that is, the visibility of the view and the UI element should match.

The tooltip property does not affect the appearance of the UI element.

Description of the UI Element Properties

·        maxVisibleMessage
Describes the maximum number of messages that appear without a scrollbar. A negative or null value means “unlimited” and all messages appear without a scrollbar.

 

Overview of Inherited and Additional Properties

Name	Interface	Type	Initial Value	Bindable	Value Required
enabled	IWDUIElement	boolean	true	bindable	No
maxVisibleMessages	IWDMessageArea	int	0	not_bindable	No
tooltip	IWDUIElement	String		bindable	No
visible	IWDUIElement	WDVisibility	visible	bindable	No

 

Methods in the Web Dynpro IWDMessageArea API

Method Name	Parameter	Return Value	Description
getMaxVisibleMessages		int	Returns the value of the maxVisibleMessages property.
setMaxVisibleMessages	(int maxVisibleMessages)		Sets the value of the maxVisibleMessages property.

Additional methods are available using inheritance:

IWDUIElement, IWDViewElement.

For detailed documentation of all inherited methods, see the documentation for the relevant APIs.