IEditorValidationProvider


1   /*******************************************************************************
2    * Copyright (c) 2005, 2006 IBM Corporation and others.
3    * All rights reserved. This program and the accompanying materials
4    * are made available under the terms of the Eclipse Public License v1.0
5    * which accompanies this distribution, and is available at
6    * http://www.eclipse.org/legal/epl-v10.html
7    *
8    * Contributors:
9    *     IBM Corporation - initial API and implementation
10   *******************************************************************************/
11  package org.eclipse.pde.internal.ui.editor;
12  
13  /**
14   * Classes that implement this interface will have the ability
15   * to contriubte to an editors validator.
16   *
17   */
18  public interface IEditorValidationProvider {
19      /**
20       * Set a validator assiciated with this object
21       * @param validator
22       */
23      public void setValidator(IEditorValidator validator);
24      /**
25       * Return the validator currently associated with this object
26       * @return the IEditorValidator associated with this object
27       */
28      public IEditorValidator getValidator() ;
29      /**
30       * Validate this object.  This method will have to be called
31       * by the object itself, preferrably during the modification of
32       * that object's field.
33       *
34       */
35      public void validate();
36      /**
37       * Returns the input value of the object
38       * @return value
39       */
40      public String   getProviderValue();
41      /**
42       * Returns the details on the contents of this provider.
43       * eg. label
44       * @return details/information
45       */
46      public String   getProviderDescription();
47  }
48

A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame

Popular Tags