|
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||
java.lang.Objectorg.eclipse.wst.validation.ReporterHelper
public class ReporterHelper
This is a temporary class to ease the transition from the previous validation framework.
This is not API.
| Constructor Summary | |
|---|---|
ReporterHelper(IProgressMonitor monitor)
|
|
| Method Summary | |
|---|---|
void |
addMessage(IValidator origin,
IMessage message)
Add a locale-independent validation message. |
void |
displaySubtask(IValidator validator,
IMessage message)
Show a text representation of this message, formatted in the default Locale, to the user immediately. |
java.util.List<IMessage> |
getMessages()
|
boolean |
isCancelled()
Return true if the user canceled validation, and false otherwise. |
void |
makeMarkers()
|
void |
removeAllMessages(IValidator origin)
Remove all validation messages entered by the identified validator. |
void |
removeAllMessages(IValidator origin,
java.lang.Object object)
Remove all validation messages, entered by the identified validator, pertaining to the Object provided. |
void |
removeMessageSubset(IValidator validator,
java.lang.Object obj,
java.lang.String groupName)
To support removal of a subset of validation messages, an IValidator may assign group names to IMessages. |
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public ReporterHelper(IProgressMonitor monitor)
| Method Detail |
|---|
public void addMessage(IValidator origin,
IMessage message)
IReporterAdd a locale-independent validation message. It will be displayed later, with all of the other validation messages.
The IValidator passed in is needed for incremental validation (when a message needs to be removed, one validator should not remove messages entered by another validator.) The validator is also queried for information about its resource bundle, to enable support for localization of messages in a client-server environment.
Both parameters must not be null.
addMessage in interface IReporterorigin - The validator which is the source of the message.message - A message to be reported.
public void displaySubtask(IValidator validator,
IMessage message)
IReporterBoth parameters must not be null.
displaySubtask in interface IReportervalidator - The validator issuing the subtask message.message - The message to be displayed to the user.public java.util.List<IMessage> getMessages()
getMessages in interface IReporterpublic boolean isCancelled()
IReporter
isCancelled in interface IReporterpublic void removeAllMessages(IValidator origin)
IReporterThe IValidator parameter must not be null.
removeAllMessages in interface IReporterorigin - Originator validator of the message.
public void removeAllMessages(IValidator origin,
java.lang.Object object)
IReporterobject is null, then this method should remove all
messages owned by the validator. (i.e., the same behaviour as the
removeAllMessages(IValidator) method.) The IValidator parameter must not be null.
removeAllMessages in interface IReporterorigin - Originator validator of the message.object - Object to which the message belongs. Object is the target object
that was set on the IMessage when adding the message as problem
marker.
public void removeMessageSubset(IValidator validator,
java.lang.Object obj,
java.lang.String groupName)
IReporterThe IValidator parameter must not be null.
If object is null, then this method should remove all
messages owned by the validator. (i.e., the same behaviour as the
removeAllMessages(IValidator) method.)
If groupName is null, that's the same as no group (i.e., the same
behaviour as the removeAllMessages(IValidator, Object)
method.)
removeMessageSubset in interface IReportervalidator - Originator validator of the message.obj - Object to which the message belongs.groupName - Name of the group to which the message belongs.public void makeMarkers()
|
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||