com.ebasetech.xi.api
Interface MessageContainer

All Known Subinterfaces:

BarcodeControl, ButtonColumnControl, ButtonControl, ContainerControl, Control, DynamicMenuItemControl, EbaseButtonControlProperties, FieldColumnControl, FieldControl, FinishButtonControl, GridCellControl, GridControl, GroupAndPagePanelProperties, GroupPanelControl, HorizontalLineControl, HorizontalMenuControl, HTMLControl, HyperlinkControl, ImageColumnControl, ImageControl, IncludeControl, LayoutControl, MenuControl, MenuItemControl, MessageControl, NextPageButtonControl, Page, PageBreakControl, PageControl, PageNavigationPanel, PagePanelControl, PanelControl, PrevPageButtonControl, RepeatingTableControl, RepeatingTableRowControl, RestoreButtonControl, SaveButtonControl, SpacerControl, StaticMenuItemControl, TabControl, TableControl, TablePageControl, TabSetControl, TextControl, TitlePanelControl, VerticalMenuControl, WebForm, WebFormEventOwner

public interface MessageContainer

The MessageContainer represents any element (a Control or Page) that supports the addition of error and warning messages.

Since:

V4.4

Method Summary

void	addErrorMessage(int messageNo) Adds an error message that will be displayed to the user.
void	addErrorMessage(int messageNo, java.lang.String[] replaceParameters) Adds an error message that will be displayed to the user.
void	addErrorMessage(int messageNo, java.lang.String[] replaceParameters, boolean stopProcessing) Adds an error message that will be displayed to the user.
void	addErrorMessage(java.lang.String message) Adds an error message that will be displayed to the user.
void	addErrorMessage(java.lang.String message, boolean stopProcessing) Adds an error message that will be displayed to the user.
void	addWarningMessage(int messageNo) Adds a warning message that will be displayed to the user.
void	addWarningMessage(int messageNo, java.lang.String[] replaceParameters) Adds a warning message that will be displayed to the user.
void	addWarningMessage(int messageNo, java.lang.String[] replaceParameters, boolean stopProcessing) Adds a warning message that will be displayed to the user.
void	addWarningMessage(java.lang.String message) Adds a warning message that will be displayed to the user Messages are removed automatically by the system once they have been displayed to the user.
void	addWarningMessage(java.lang.String message, boolean stopProcessing) Adds a warning message that will be displayed to the user.
boolean	existErrorMessages() Returns true if undisplayed error messages exist for this element, otherwise returns false.
boolean	existMessages() Returns true if undisplayed warning or error messages exist for this element, otherwise returns false.
boolean	existWarningMessages() Returns true if undisplayed warning messages exist for this element, otherwise returns false.

Method Detail

addErrorMessage

void addErrorMessage(java.lang.String message)

Adds an error message that will be displayed to the user. Messages are removed automatically by the system once they have been displayed to the user.

This method is equivalent to addErrorMessage(message, true).

All processing for the current event is stopped immediately and the page is redisplayed to the user so the error can be corrected.

Messages can be displayed either locally to the message owner (a control or page) or at another location on the same page represented by a Message Control. For further information on the location and styling of messages, please see the online documentation available from the Help menu, search on message options, then follow the link to Message Options For Controls.

Javascript example:

 event.owner.addErrorMessage("Please supply a valid reference code");
 

Parameters:

message - the message to be added

Since:

V4.4

See Also:

addErrorMessage(int, String[]), addErrorMessage(String, boolean), existErrorMessages()

addErrorMessage

void addErrorMessage(java.lang.String message,
                     boolean stopProcessing)

Adds an error message that will be displayed to the user. Messages are removed automatically by the system once they have been displayed to the user.

When stopProcessing is true, all processing for the current event is stopped immediately and the page is redisplayed to the user so the error can be corrected. When stopProcessing is false, processing continues normally, except that the user is prevented from navigating forwards to another page using a Next Page Button Control or the next page button within a Page Navigation Panel Control. Note that the same restriction does not apply when navigating to another page using other methods e.g. the WebForm.gotoPage(Page) method.

Set stopProcessing to false when there is a requirement to display multiple error messages on a page. EventContext.stopExecution() can then be used at a later point to stop processing and display the messages to the user.

Messages can be displayed either locally to the message owner (a control or page) or at another location on the same page represented by a Message Control. For further information on the location and styling of messages, please see the online documentation available from the Help menu, search on message options, then follow the link to Message Options For Controls.

Javascript example:

 event.owner.addErrorMessage("Please supply a valid reference code", false);
 

Parameters:

message - the message to be added

stopProcessing - when true, immediately stops processing for the current event

Since:

V4.4

See Also:

addErrorMessage(int, String[], boolean), existErrorMessages(), EventContext.stopExecution()

addErrorMessage

void addErrorMessage(int messageNo,
                     java.lang.String[] replaceParameters)
                     throws com.ebasetech.xi.exceptions.FormRuntimeException

Adds an error message that will be displayed to the user. This method supports the addition of a pre-defined message that supports multiple languages and the substitution of variables. Messages are removed automatically by the system once they have been displayed to the user.

This method is equivalent to addErrorMessage(messageNo, replaceParameters, true).

A message is added using its message number. Numbered messages are defined within each project using the Messages Editor - double click on the Messages element within each project in the designer tree. Within each message, a substitutable variable is identified by &&. Any substitutable variables in the message are replaced with values in the replaceParameters parameter (see example below).

All processing for the current event is stopped immediately and the page is redisplayed to the user so the error can be corrected.

Messages can be displayed either locally to the message owner (a control or page) or at another location on the same page represented by a Message Control. For further information on the location and styling of messages, please see the online documentation available from the Help menu, search on message options, then follow the link to Message Options For Controls.

Javascript example:

 event.owner.addErrorMessage(1006, [fields.ORDER_TYPE.value, fields.CUSTOMER_TYPE.value]);
 

If message 1006 in language EN contains text:
Order type && is invalid for customer type &&
this might be displayed as:
Order type CREDIT is invalid for customer type PUBLIC

Parameters:

messageNo - the message number to be added

replaceParameters - an array of values to replace any substitutable parameters in the message defined as &&

Throws:

com.ebasetech.xi.exceptions.FormRuntimeException

Since:

V4.4

See Also:

addErrorMessage(String), existErrorMessages()

addErrorMessage

void addErrorMessage(int messageNo)
                     throws com.ebasetech.xi.exceptions.FormRuntimeException

Adds an error message that will be displayed to the user. This method is equivalent to addErrorMessage(messageNo, null).

Parameters:

messageNo - the message number to be added

Throws:

com.ebasetech.xi.exceptions.FormRuntimeException

Since:

V4.4

See Also:

addErrorMessage(int, String[])

addErrorMessage

void addErrorMessage(int messageNo,
                     java.lang.String[] replaceParameters,
                     boolean stopProcessing)
                     throws com.ebasetech.xi.exceptions.FormRuntimeException

Adds an error message that will be displayed to the user. This method supports the addition of a pre-defined message that supports multiple languages and the substitution of variables. Messages are removed automatically by the system once they have been displayed to the user.

A message is added using its message number. Numbered messages are defined within each project using the Messages Editor - double click on the Messages element within each project in the designer tree. Within each message, a substitutable variable is identified by &&. Any substitutable variables in the message are replaced with values in the replaceParameters parameter (see example below).

When stopProcessing is true, all processing for the current event is stopped immediately and the page is redisplayed to the user so the error can be corrected. When stopProcessing is false, processing continues normally, except that the user is prevented from navigating forwards to another page using a Next Page Button Control or the next page button within a Page Navigation Panel Control. Note that the same restriction does not apply when navigating to another page using other methods e.g. the WebForm.gotoPage(Page) method.

Set stopProcessing to false when there is a requirement to display multiple error messages on a page. EventContext.stopExecution() can then be used at a later point to stop processing and display the messages to the user.

Messages can be displayed either locally to the message owner (a control or page) or at another location on the same page represented by a Message Control. For further information on the location and styling of messages, please see the online documentation available from the Help menu, search on message options, then follow the link to Message Options For Controls.

Javascript example:

 event.owner.addErrorMessage(1006, [fields.ORDER_TYPE.value, fields.CUSTOMER_TYPE.value], false);
 

If message 1006 in language EN contains text:
Order type && is invalid for customer type &&
this might be displayed as:
Order type CREDIT is invalid for customer type PUBLIC

Parameters:

messageNo - the message number to be added

replaceParameters - an array of values to replace any substitutable parameters in the message defined as &&

stopProcessing - when true, immediately stops processing for the current event

Throws:

com.ebasetech.xi.exceptions.FormRuntimeException

Since:

V4.4

See Also:

addErrorMessage(String), addErrorMessage(int, String[], boolean), existErrorMessages(), EventContext.stopExecution()

addWarningMessage

void addWarningMessage(java.lang.String message)

Adds a warning message that will be displayed to the user Messages are removed automatically by the system once they have been displayed to the user.

This method is equivalent to addWarningMessage(message, false).

When a warning or error message exists on a page, the user is prevented from navigating forwards to another page using a Next Page Button Control or the next page button within a Page Navigation Panel Control. Note that the same restriction does not apply when navigating to another page using other methods e.g. the WebForm.gotoPage(Page) method.

Messages can be displayed either locally to the message owner (a control or page) or at another location on the same page represented by a Message Control. For further information on the location and styling of messages, please see the online documentation available from the Help menu, search on message options, then follow the link to Message Options For Controls.

Javascript example:

 event.owner.addWarningMessage("Extra charges apply for this service");
 

Parameters:

message - the message to be added

Since:

V4.4

See Also:

addWarningMessage(int, String[]), addWarningMessage(String, boolean), existWarningMessages()

addWarningMessage

void addWarningMessage(java.lang.String message,
                       boolean stopProcessing)

Adds a warning message that will be displayed to the user. Messages are removed automatically by the system once they have been displayed to the user.

When a warning or error message exists on a page, the user is prevented from navigating forwards to another page using a Next Page Button Control or the next page button within a Page Navigation Panel Control. Note that the same restriction does not apply when navigating to another page using other methods e.g. the WebForm.gotoPage(Page) method.

When stopProcessing is true, all processing for the current event is stopped immediately and the page is redisplayed to the user.

Messages can be displayed either locally to the message owner (a control or page) or at another location on the same page represented by a Message Control. For further information on the location and styling of messages, please see the online documentation available from the Help menu, search on message options, then follow the link to Message Options For Controls.

Javascript example:

 event.owner.addWarningMessage("Extra charges apply for this service", false);
 

Parameters:

message - the message to be added

stopProcessing - when true, immediately stops processing for the current event

Since:

V4.4

See Also:

addWarningMessage(int, String[]), existWarningMessages()

addWarningMessage

void addWarningMessage(int messageNo)
                       throws com.ebasetech.xi.exceptions.FormRuntimeException

Adds a warning message that will be displayed to the user. This method is equivalent to addWarningMessage(messageNo, null).

Parameters:

messageNo - the message number to be added

Throws:

com.ebasetech.xi.exceptions.FormRuntimeException

Since:

V4.4

See Also:

addWarningMessage(int, String[])

addWarningMessage

void addWarningMessage(int messageNo,
                       java.lang.String[] replaceParameters)
                       throws com.ebasetech.xi.exceptions.FormRuntimeException

Adds a warning message that will be displayed to the user. This method supports the addition of a pre-defined message that supports multiple languages and the substitution of variables. Messages are removed automatically by the system once they have been displayed to the user.

This method is equivalent to addWarningMessage(messageNo, replaceParameters, false).

A message is added using its message number. Numbered messages are defined within each project using the Messages Editor - double click on the Messages element within each project in the designer tree. Within each message, a substitutable variable is identified by &&. Any substitutable variables in the message are replaced with values in the replaceParameters parameter (see example below).

When a warning or error message exists on a page, the user is prevented from navigating forwards to another page using a Next Page Button Control or the next page button within a Page Navigation Panel Control. Note that the same restriction does not apply when navigating to another page using other methods e.g. the WebForm.gotoPage(Page) method.

Messages can be displayed either locally to the message owner (a control or page) or at another location on the same page represented by a Message Control. For further information on the location and styling of messages, please see the online documentation available from the Help menu, search on message options, then follow the link to Message Options For Controls.

Javascript example:

 event.owner.addWarningMessage(1006, [fields.ORDER_TYPE.value, fields.CUSTOMER_TYPE.value]);
 

If message 1006 in language EN contains text:
An additional charge of && applies to this service
this might be displayed as:
An additional charge of $100.00 applies to this service

Parameters:

messageNo - the message number to be added

replaceParameters - an array of values to replace any substitutable parameters in the message defined as &&

Throws:

com.ebasetech.xi.exceptions.FormRuntimeException

Since:

V4.4

See Also:

addWarningMessage(String), addWarningMessage(int, String[], boolean), existWarningMessages()

addWarningMessage

void addWarningMessage(int messageNo,
                       java.lang.String[] replaceParameters,
                       boolean stopProcessing)
                       throws com.ebasetech.xi.exceptions.FormRuntimeException

Adds a warning message that will be displayed to the user. This method supports the addition of a pre-defined message that supports multiple languages and the substitution of variables. Messages are removed automatically by the system once they have been displayed to the user.

A message is added using its message number. Numbered messages are defined within each project using the Messages Editor - double click on the Messages element within each project in the designer tree. Within each message, a substitutable variable is identified by &&. Any substitutable variables in the message are replaced with values in the replaceParameters parameter (see example below).

When a warning or error message exists on a page, the user is prevented from navigating forwards to another page using a Next Page Button Control or the next page button within a Page Navigation Panel Control. Note that the same restriction does not apply when navigating to another page using other methods e.g. the WebForm.gotoPage(Page) method.

When stopProcessing is true, all processing for the current event is stopped immediately and the page is redisplayed to the user.

Messages can be displayed either locally to the message owner (a control or page) or at another location on the same page represented by a Message Control. For further information on the location and styling of messages, please see the online documentation available from the Help menu, search on message options, then follow the link to Message Options For Controls.

Javascript example:

 event.owner.addWarningMessage(1006, [fields.ORDER_TYPE.value, fields.CUSTOMER_TYPE.value], false);
 

If message 1006 in language EN contains text:
An additional charge of && applies to this service
this might be displayed as:
An additional charge of $100.00 applies to this service

Parameters:

messageNo - the message number to be added

replaceParameters - an array of values to replace any substitutable parameters in the message defined as &&

stopProcessing - when true, immediately stops processing for the current event

Throws:

com.ebasetech.xi.exceptions.FormRuntimeException

Since:

V4.4

See Also:

addWarningMessage(String), existWarningMessages()

existErrorMessages

boolean existErrorMessages()

Returns true if undisplayed error messages exist for this element, otherwise returns false. Undisplayed error messages will be displayed when the page is next presented to the user.

Since:

V4.4

existWarningMessages

boolean existWarningMessages()

Returns true if undisplayed warning messages exist for this element, otherwise returns false. Undisplayed warning messages will be displayed when the page is next presented to the user.

Since:

V4.4

existMessages

boolean existMessages()

Returns true if undisplayed warning or error messages exist for this element, otherwise returns false. Undisplayed messages will be displayed when the page is next presented to the user.

Since:

V4.5.1