XSLCustomizer


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  
20  package org.netbeans.modules.xsl.api;
21  
22  import org.w3c.dom.Node  ;
23  import java.awt.Component  ;
24  import org.openide.loaders.DataObject;
25  
26  /**
27   * The <code>XPathCustomizer</code> is an interface to enable editing an XPath in a source document.
28   * By implementing the interface any editor can launch the <code>XPathCustomizer</code> when an XPath needs
29   * to be customized.
30    */
31  public interface XSLCustomizer {    
32      /**
33       * Returns the <code>Component</code> used to edit the XPath.
34       * @param node the <code>Node</code> instance to be customized.
35       * @param dataObject the <code>DataObject</code> representing the XSL document.
36       *            <code>ScenarioCookie</code> can be fetched from this DataObject using
37       *            <code>dataObject.getCookie(ScenarioCookie.class)</code>.
38       * @return the <code>Component</code> used to edit the XPath.
39       */
40      public Component   getCustomizer(Node   node, DataObject dataObject);
41  
42      /**
43       * Indicates if this customizer can return a customizing component for this
44       * node.
45       * @param node the <code>Node</code> instance to be customized.
46       * @return true if a customizer is supported for this node, otherwise false.
47       */
48      public boolean hasCustomizer(Node   node);
49  }
50
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags