View Javadoc

1   /*
2    *  Licensed to the Apache Software Foundation (ASF) under one
3    *  or more contributor license agreements.  See the NOTICE file
4    *  distributed with this work for additional information
5    *  regarding copyright ownership.  The ASF licenses this file
6    *  to you under the Apache License, Version 2.0 (the
7    *  "License"); you may not use this file except in compliance
8    *  with the License.  You may obtain a copy of the License at
9    * 
10   *  http://www.apache.org/licenses/LICENSE-2.0
11   * 
12   *  Unless required by applicable law or agreed to in writing,
13   *  software distributed under the License is distributed on an
14   *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   *  KIND, either express or implied.  See the License for the
16   *  specific language governing permissions and limitations
17   *  under the License.
18   */
19  package org.apache.myfaces.trinidad.change;
20  
21  import org.w3c.dom.Node;
22  
23  /**
24   * Document-aware Changes inrfaces.  Changes that can apply their changes
25   * to the underlying JSP DOM document, implement this interface to avoid requiring
26   * a converter class be registered with the ChangeMananger
27   * 
28   */
29  public interface DocumentChange
30  {
31    /**
32     * Apply this change to the specied root DOM Node of the component
33     * @param componentNode DOM node of the component to apply the change to
34     */
35    public void changeDocument(Node componentNode);
36    
37    /** 
38     * Returns true if adding the DocumentChange should force the JSP Document
39     * to reload
40     */
41    public boolean getForcesDocumentReload();
42  }