| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!--NewPage--> |
| <HTML> |
| <HEAD> |
| <!-- Generated by javadoc (build 1.6.0) on Tue Nov 25 07:28:12 EST 2008 --> |
| <TITLE> |
| ReporterHelper |
| </TITLE> |
| |
| <META NAME="date" CONTENT="2008-11-25"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="ReporterHelper"; |
| } |
| } |
| </SCRIPT> |
| <NOSCRIPT> |
| </NOSCRIPT> |
| |
| </HEAD> |
| |
| <BODY BGCOLOR="white" onload="windowTitle();"> |
| <HR> |
| |
| |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <A NAME="navbar_top"><!-- --></A> |
| <A HREF="#skip-navbar_top" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_top_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ReporterHelper.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../serialized-form.html"><FONT CLASS="NavBarFont1"><B>Serialized</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../org/eclipse/wst/validation/PerformanceCounters.html" title="class in org.eclipse.wst.validation"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/eclipse/wst/validation/ValidationFramework.html" title="class in org.eclipse.wst.validation"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/eclipse/wst/validation/ReporterHelper.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="ReporterHelper.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_top"></A> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| |
| <HR> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <H2> |
| <FONT SIZE="-1"> |
| org.eclipse.wst.validation</FONT> |
| <BR> |
| Class ReporterHelper</H2> |
| <PRE> |
| java.lang.Object |
| <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.eclipse.wst.validation.ReporterHelper</B> |
| </PRE> |
| <DL> |
| <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../org/eclipse/wst/validation/internal/provisional/core/IReporter.html" title="interface in org.eclipse.wst.validation.internal.provisional.core">IReporter</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public class <B>ReporterHelper</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../org/eclipse/wst/validation/internal/provisional/core/IReporter.html" title="interface in org.eclipse.wst.validation.internal.provisional.core">IReporter</A></DL> |
| </PRE> |
| |
| <P> |
| This is a temporary class to ease the transition from the previous validation framework. |
| <p> |
| This is not API. |
| <P> |
| |
| <P> |
| <HR> |
| |
| <P> |
| |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| |
| <A NAME="constructor_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Constructor Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/ReporterHelper.html#ReporterHelper(IProgressMonitor)">ReporterHelper</A></B>(IProgressMonitor monitor)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ========== METHOD SUMMARY =========== --> |
| |
| <A NAME="method_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Method Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/ReporterHelper.html#addMessage(org.eclipse.wst.validation.internal.provisional.core.IValidator, org.eclipse.wst.validation.internal.provisional.core.IMessage)">addMessage</A></B>(<A HREF="../../../../org/eclipse/wst/validation/internal/provisional/core/IValidator.html" title="interface in org.eclipse.wst.validation.internal.provisional.core">IValidator</A> origin, |
| <A HREF="../../../../org/eclipse/wst/validation/internal/provisional/core/IMessage.html" title="interface in org.eclipse.wst.validation.internal.provisional.core">IMessage</A> message)</CODE> |
| |
| <BR> |
| |
| Add a locale-independent validation message.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/ReporterHelper.html#displaySubtask(org.eclipse.wst.validation.internal.provisional.core.IValidator, org.eclipse.wst.validation.internal.provisional.core.IMessage)">displaySubtask</A></B>(<A HREF="../../../../org/eclipse/wst/validation/internal/provisional/core/IValidator.html" title="interface in org.eclipse.wst.validation.internal.provisional.core">IValidator</A> validator, |
| <A HREF="../../../../org/eclipse/wst/validation/internal/provisional/core/IMessage.html" title="interface in org.eclipse.wst.validation.internal.provisional.core">IMessage</A> message)</CODE> |
| |
| <BR> |
| Show a text representation of this message, formatted in the default |
| Locale, to the user immediately.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.util.List<<A HREF="../../../../org/eclipse/wst/validation/internal/provisional/core/IMessage.html" title="interface in org.eclipse.wst.validation.internal.provisional.core">IMessage</A>></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/ReporterHelper.html#getMessages()">getMessages</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/ReporterHelper.html#isCancelled()">isCancelled</A></B>()</CODE> |
| |
| <BR> |
| Return true if the user canceled validation, and false otherwise.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/ReporterHelper.html#makeMarkers()">makeMarkers</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/ReporterHelper.html#removeAllMessages(org.eclipse.wst.validation.internal.provisional.core.IValidator)">removeAllMessages</A></B>(<A HREF="../../../../org/eclipse/wst/validation/internal/provisional/core/IValidator.html" title="interface in org.eclipse.wst.validation.internal.provisional.core">IValidator</A> origin)</CODE> |
| |
| <BR> |
| Remove all validation messages entered by the identified validator.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/ReporterHelper.html#removeAllMessages(org.eclipse.wst.validation.internal.provisional.core.IValidator, java.lang.Object)">removeAllMessages</A></B>(<A HREF="../../../../org/eclipse/wst/validation/internal/provisional/core/IValidator.html" title="interface in org.eclipse.wst.validation.internal.provisional.core">IValidator</A> origin, |
| java.lang.Object object)</CODE> |
| |
| <BR> |
| Remove all validation messages, entered by the identified validator, |
| pertaining to the Object provided.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/ReporterHelper.html#removeMessageSubset(org.eclipse.wst.validation.internal.provisional.core.IValidator, java.lang.Object, java.lang.String)">removeMessageSubset</A></B>(<A HREF="../../../../org/eclipse/wst/validation/internal/provisional/core/IValidator.html" title="interface in org.eclipse.wst.validation.internal.provisional.core">IValidator</A> validator, |
| java.lang.Object obj, |
| java.lang.String groupName)</CODE> |
| |
| <BR> |
| To support removal of a subset of validation messages, an IValidator may |
| assign group names to IMessages.</TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| |
| <A NAME="constructor_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Constructor Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="ReporterHelper(IProgressMonitor)"><!-- --></A><H3> |
| ReporterHelper</H3> |
| <PRE> |
| public <B>ReporterHelper</B>(IProgressMonitor monitor)</PRE> |
| <DL> |
| </DL> |
| |
| <!-- ============ METHOD DETAIL ========== --> |
| |
| <A NAME="method_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Method Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="addMessage(org.eclipse.wst.validation.internal.provisional.core.IValidator, org.eclipse.wst.validation.internal.provisional.core.IMessage)"><!-- --></A><H3> |
| addMessage</H3> |
| <PRE> |
| public void <B>addMessage</B>(<A HREF="../../../../org/eclipse/wst/validation/internal/provisional/core/IValidator.html" title="interface in org.eclipse.wst.validation.internal.provisional.core">IValidator</A> origin, |
| <A HREF="../../../../org/eclipse/wst/validation/internal/provisional/core/IMessage.html" title="interface in org.eclipse.wst.validation.internal.provisional.core">IMessage</A> message)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/eclipse/wst/validation/internal/provisional/core/IReporter.html#addMessage(org.eclipse.wst.validation.internal.provisional.core.IValidator, org.eclipse.wst.validation.internal.provisional.core.IMessage)">IReporter</A></CODE></B></DD> |
| <DD><p> |
| Add a locale-independent validation message. It will be displayed later, with all of the |
| other validation messages. |
| </p> |
| <p> |
| 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. |
| </p> |
| <p> |
| Both parameters must not be null. |
| </p> |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/eclipse/wst/validation/internal/provisional/core/IReporter.html#addMessage(org.eclipse.wst.validation.internal.provisional.core.IValidator, org.eclipse.wst.validation.internal.provisional.core.IMessage)">addMessage</A></CODE> in interface <CODE><A HREF="../../../../org/eclipse/wst/validation/internal/provisional/core/IReporter.html" title="interface in org.eclipse.wst.validation.internal.provisional.core">IReporter</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>origin</CODE> - The validator which is the source of the message.<DD><CODE>message</CODE> - A message to be reported.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="displaySubtask(org.eclipse.wst.validation.internal.provisional.core.IValidator, org.eclipse.wst.validation.internal.provisional.core.IMessage)"><!-- --></A><H3> |
| displaySubtask</H3> |
| <PRE> |
| public void <B>displaySubtask</B>(<A HREF="../../../../org/eclipse/wst/validation/internal/provisional/core/IValidator.html" title="interface in org.eclipse.wst.validation.internal.provisional.core">IValidator</A> validator, |
| <A HREF="../../../../org/eclipse/wst/validation/internal/provisional/core/IMessage.html" title="interface in org.eclipse.wst.validation.internal.provisional.core">IMessage</A> message)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/eclipse/wst/validation/internal/provisional/core/IReporter.html#displaySubtask(org.eclipse.wst.validation.internal.provisional.core.IValidator, org.eclipse.wst.validation.internal.provisional.core.IMessage)">IReporter</A></CODE></B></DD> |
| <DD>Show a text representation of this message, formatted in the default |
| Locale, to the user immediately. This message indicates which subtask is |
| currently being processed. The message is not stored. The subtask message |
| in this context is the subtask in a IProgressMontior |
| <p> |
| Both parameters must not be null. |
| </p> |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/eclipse/wst/validation/internal/provisional/core/IReporter.html#displaySubtask(org.eclipse.wst.validation.internal.provisional.core.IValidator, org.eclipse.wst.validation.internal.provisional.core.IMessage)">displaySubtask</A></CODE> in interface <CODE><A HREF="../../../../org/eclipse/wst/validation/internal/provisional/core/IReporter.html" title="interface in org.eclipse.wst.validation.internal.provisional.core">IReporter</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>validator</CODE> - The validator issuing the subtask message.<DD><CODE>message</CODE> - The message to be displayed to the user.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getMessages()"><!-- --></A><H3> |
| getMessages</H3> |
| <PRE> |
| public java.util.List<<A HREF="../../../../org/eclipse/wst/validation/internal/provisional/core/IMessage.html" title="interface in org.eclipse.wst.validation.internal.provisional.core">IMessage</A>> <B>getMessages</B>()</PRE> |
| <DL> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/eclipse/wst/validation/internal/provisional/core/IReporter.html#getMessages()">getMessages</A></CODE> in interface <CODE><A HREF="../../../../org/eclipse/wst/validation/internal/provisional/core/IReporter.html" title="interface in org.eclipse.wst.validation.internal.provisional.core">IReporter</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the message access interface to this reporter, or null if message access is not |
| supported.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isCancelled()"><!-- --></A><H3> |
| isCancelled</H3> |
| <PRE> |
| public boolean <B>isCancelled</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/eclipse/wst/validation/internal/provisional/core/IReporter.html#isCancelled()">IReporter</A></CODE></B></DD> |
| <DD>Return true if the user canceled validation, and false otherwise. This method should be |
| called by IValidators periodically, because no event is fired to notify IValidators that the |
| user canceled validation. If a validator does not check this method, a cancellation request |
| is ignored. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/eclipse/wst/validation/internal/provisional/core/IReporter.html#isCancelled()">isCancelled</A></CODE> in interface <CODE><A HREF="../../../../org/eclipse/wst/validation/internal/provisional/core/IReporter.html" title="interface in org.eclipse.wst.validation.internal.provisional.core">IReporter</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>true if the user canceled validation, and false otherwise.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="removeAllMessages(org.eclipse.wst.validation.internal.provisional.core.IValidator)"><!-- --></A><H3> |
| removeAllMessages</H3> |
| <PRE> |
| public void <B>removeAllMessages</B>(<A HREF="../../../../org/eclipse/wst/validation/internal/provisional/core/IValidator.html" title="interface in org.eclipse.wst.validation.internal.provisional.core">IValidator</A> origin)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/eclipse/wst/validation/internal/provisional/core/IReporter.html#removeAllMessages(org.eclipse.wst.validation.internal.provisional.core.IValidator)">IReporter</A></CODE></B></DD> |
| <DD>Remove all validation messages entered by the identified validator. This method is provided |
| for incremental validation. |
| <p> |
| The IValidator parameter must not be null. |
| </p> |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/eclipse/wst/validation/internal/provisional/core/IReporter.html#removeAllMessages(org.eclipse.wst.validation.internal.provisional.core.IValidator)">removeAllMessages</A></CODE> in interface <CODE><A HREF="../../../../org/eclipse/wst/validation/internal/provisional/core/IReporter.html" title="interface in org.eclipse.wst.validation.internal.provisional.core">IReporter</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>origin</CODE> - Originator validator of the message.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="removeAllMessages(org.eclipse.wst.validation.internal.provisional.core.IValidator, java.lang.Object)"><!-- --></A><H3> |
| removeAllMessages</H3> |
| <PRE> |
| public void <B>removeAllMessages</B>(<A HREF="../../../../org/eclipse/wst/validation/internal/provisional/core/IValidator.html" title="interface in org.eclipse.wst.validation.internal.provisional.core">IValidator</A> origin, |
| java.lang.Object object)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/eclipse/wst/validation/internal/provisional/core/IReporter.html#removeAllMessages(org.eclipse.wst.validation.internal.provisional.core.IValidator, java.lang.Object)">IReporter</A></CODE></B></DD> |
| <DD>Remove all validation messages, entered by the identified validator, |
| pertaining to the Object provided. This method is provided for |
| incremental validation. <br> |
| <br> |
| If <code>object</code> is null, then this method should remove all |
| messages owned by the validator. (i.e., the same behaviour as the |
| removeAllMessages(IValidator) method.) <br> |
| <br> |
| <p> |
| The IValidator parameter must not be null. |
| </p> |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/eclipse/wst/validation/internal/provisional/core/IReporter.html#removeAllMessages(org.eclipse.wst.validation.internal.provisional.core.IValidator, java.lang.Object)">removeAllMessages</A></CODE> in interface <CODE><A HREF="../../../../org/eclipse/wst/validation/internal/provisional/core/IReporter.html" title="interface in org.eclipse.wst.validation.internal.provisional.core">IReporter</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>origin</CODE> - Originator validator of the message.<DD><CODE>object</CODE> - Object to which the message belongs. Object is the target object |
| that was set on the IMessage when adding the message as problem |
| marker.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="removeMessageSubset(org.eclipse.wst.validation.internal.provisional.core.IValidator, java.lang.Object, java.lang.String)"><!-- --></A><H3> |
| removeMessageSubset</H3> |
| <PRE> |
| public void <B>removeMessageSubset</B>(<A HREF="../../../../org/eclipse/wst/validation/internal/provisional/core/IValidator.html" title="interface in org.eclipse.wst.validation.internal.provisional.core">IValidator</A> validator, |
| java.lang.Object obj, |
| java.lang.String groupName)</PRE> |
| <DL> |
| <DD><B>Description copied from interface: <CODE><A HREF="../../../../org/eclipse/wst/validation/internal/provisional/core/IReporter.html#removeMessageSubset(org.eclipse.wst.validation.internal.provisional.core.IValidator, java.lang.Object, java.lang.String)">IReporter</A></CODE></B></DD> |
| <DD>To support removal of a subset of validation messages, an IValidator may |
| assign group names to IMessages. An IMessage subset will be identified by |
| the name of its group. This method will remove only the IMessage's that |
| are in the group identified by groupName. |
| <p> |
| The IValidator parameter must not be null. |
| </p> |
| <p> |
| If <code>object</code> is null, then this method should remove all |
| messages owned by the validator. (i.e., the same behaviour as the |
| removeAllMessages(IValidator) method.) |
| </p> |
| <p> |
| If groupName is null, that's the same as no group (i.e., the same |
| behaviour as the <code>removeAllMessages(IValidator, Object)</code> |
| method.) |
| </p> |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/eclipse/wst/validation/internal/provisional/core/IReporter.html#removeMessageSubset(org.eclipse.wst.validation.internal.provisional.core.IValidator, java.lang.Object, java.lang.String)">removeMessageSubset</A></CODE> in interface <CODE><A HREF="../../../../org/eclipse/wst/validation/internal/provisional/core/IReporter.html" title="interface in org.eclipse.wst.validation.internal.provisional.core">IReporter</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>validator</CODE> - Originator validator of the message.<DD><CODE>obj</CODE> - Object to which the message belongs.<DD><CODE>groupName</CODE> - Name of the group to which the message belongs.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="makeMarkers()"><!-- --></A><H3> |
| makeMarkers</H3> |
| <PRE> |
| public void <B>makeMarkers</B>()</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <HR> |
| |
| |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <A NAME="navbar_bottom"><!-- --></A> |
| <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_bottom_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ReporterHelper.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../serialized-form.html"><FONT CLASS="NavBarFont1"><B>Serialized</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../org/eclipse/wst/validation/PerformanceCounters.html" title="class in org.eclipse.wst.validation"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/eclipse/wst/validation/ValidationFramework.html" title="class in org.eclipse.wst.validation"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/eclipse/wst/validation/ReporterHelper.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="ReporterHelper.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| |
| </BODY> |
| </HTML> |