1 /*
2 * Copyright 2004-2008 the Seasar Foundation and the Others.
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,
13 * either express or implied. See the License for the specific language
14 * governing permissions and limitations under the License.
15 */
16 package org.seasar.uruma.component;
17
18 import org.seasar.uruma.component.factory.UrumaTagHandler;
19
20 /**
21 * 画面定義テンプレートの要素を表すインターフェースです。<br />
22 *
23 * @author y-komori
24 */
25 public interface UIElement extends UIElementVisitorAcceptor {
26 /**
27 * 画面定義テンプレートファイルのパスを設定します。<br />
28 *
29 * @param path
30 * パス
31 */
32 public void setPath(String path);
33
34 /**
35 * 画面定義テンプレートファイルのパスを取得します。<br />
36 *
37 * @return パス
38 */
39 public String getPath();
40
41 /**
42 * 画面定義テンプレートファイルのベースパスを設定します。<br />
43 * <code>basePath</code> は {@link UrumaTagHandler} によって設定されます。
44 *
45 * @param basePath
46 * 画面定義データファイルのベースパス
47 */
48 public void setBasePath(String basePath);
49
50 /**
51 * 画面定義テンプレートファイルのベースパスを取得します。<br />
52 *
53 * @return 画面定義データファイルのベースパス
54 */
55 public String getBasePath();
56
57 /**
58 * 画面定義テンプレートファイル中の要素の位置を設定します。<br />
59 * <code>location</code> は {@link UrumaTagHandler}
60 * によって設定され、主にエラーが発生時の参照のために利用されます。<br/>
61 *
62 * @param location
63 * 画面定義テンプレートファイル中の要素の位置
64 */
65 public void setLocation(String location);
66
67 /**
68 * 画面定義テンプレートファイル中の要素の位置を取得します。<br />
69 *
70 * @return 画面定義テンプレートファイル中の要素の位置
71 */
72 public String getLocation();
73 }