XMLPropertyEditor


1   /*
2    * The contents of this file are subject to the terms of the Common Development
3    * and Distribution License (the License). You may not use this file except in
4    * compliance with the License.
5    *
6    * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
7    * or http://www.netbeans.org/cddl.txt.
8    *
9    * When distributing Covered Code, include this CDDL Header Notice in each file
10   * and include the License file at http://www.netbeans.org/cddl.txt.
11   * If applicable, add the following below the CDDL Header, with the fields
12   * enclosed by brackets [] replaced by your own identifying information:
13   * "Portions Copyrighted [year] [name of copyright owner]"
14   *
15   * The Original Software is NetBeans. The Initial Developer of the Original
16   * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
17   * Microsystems, Inc. All Rights Reserved.
18   */
19  package org.openide.explorer.propertysheet.editors;
20  
21  
22  /** An interface to be implemented by property editors which want to provide
23   * a load/store of property values in human-readable XML.
24   * The XML persistence is currently used by the form editor module for storage of
25   * modified property values.
26   *
27   * @author  Ian Formanek
28   */
29  public interface XMLPropertyEditor extends java.beans.PropertyEditor   {
30      /** Called to load property value from specified XML subtree. If succesfully loaded,
31      * the value should be available via the getValue method.
32      * An IOException should be thrown when the value cannot be restored from the specified XML element
33      * @param element the XML DOM element representing a subtree of XML from which the value should be loaded
34      * @exception IOException thrown when the value cannot be restored from the specified XML element
35      */
36      public void readFromXML(org.w3c.dom.Node   element) throws java.io.IOException  ;
37  
38      /** Called to store current property value into XML subtree. The property value should be set using the
39      * setValue method prior to calling this method.
40      * @param doc The XML document to store the XML in - should be used for creating nodes only
41      * @return the XML DOM element representing a subtree of XML from which the value should be loaded
42      */
43      public org.w3c.dom.Node   storeToXML(org.w3c.dom.Document   doc);
44  }
45
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags