View Javadoc

1   /*
2    * Copyright 2002 - 2007 JEuclid, http://jeuclid.sf.net
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  
17  /* $Id: LayoutableNode.java,v 8afef6dd0d58 2007/09/14 08:29:58 maxberger $ */
18  
19  package net.sourceforge.jeuclid.layout;
20  
21  import java.util.List;
22  
23  import net.sourceforge.jeuclid.LayoutContext;
24  import net.sourceforge.jeuclid.elements.JEuclidNode;
25  
26  import org.w3c.dom.Node;
27  
28  /**
29   * @version $Revision: 8afef6dd0d58 $
30   */
31  public interface LayoutableNode extends Node, JEuclidNode {
32  
33      /**
34       * @return List of children to Layout. Normally, all children.
35       */
36      List<LayoutableNode> getChildrenToLayout();
37  
38      /**
39       * @return List of children to Draw. Normally, all children.
40       */
41      List<LayoutableNode> getChildrenToDraw();
42  
43      /**
44       * context insensitive layout.
45       * 
46       * @param view
47       *            LayoutView to use.
48       * @param info
49       *            LayoutInfo to manipulate.
50       * @param childMinStage
51       *            minimum stage of children. Either STAGE1 or STAGE2.
52       * @param context
53       *            LayoutContext for this element.
54       */
55      void layoutStage1(LayoutView view, LayoutInfo info,
56              LayoutStage childMinStage, LayoutContext context);
57  
58      /**
59       * context sensitive layout.
60       * 
61       * @param view
62       *            LayoutView to use.
63       * @param info
64       *            LayoutInfo to manipulate.
65       * @param context
66       *            LayoutContext for this element.
67       */
68      void layoutStage2(LayoutView view, LayoutInfo info, LayoutContext context);
69  
70  }