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.context;
17
18 import org.eclipse.jface.dialogs.DialogPage;
19 import org.eclipse.ui.part.EditorPart;
20 import org.eclipse.ui.part.ViewPart;
21 import org.seasar.uruma.desc.FormDesc;
22 import org.seasar.uruma.desc.PartActionDesc;
23
24 /**
25 * ウィンドウパートに関する情報を保持するクラスのための、インターフェースです。<br />
26 * ウインドウパートは、 {@link ViewPart}、{@link EditorPart}、{@link DialogPage}など、ウィンドウやダイアログを構成する独立したパートを表します。
27 *
28 * @author y-komori
29 */
30 public interface PartContext extends WidgetHolder {
31 /**
32 * ウィンドウパートの名称を返します。<br />
33 *
34 * @return ウィンドウパートの名称
35 */
36 public String getName();
37
38 /**
39 * {@link PartActionDesc} オブジェクトを取得します。<br />
40 *
41 * @return {@link PartActionDesc} オブジェクト
42 */
43 public PartActionDesc getPartActionDesc();
44
45 /**
46 * パートアクションクラスのオブジェクトを取得します。<br />
47 *
48 * @return パートアクションクラスのオブジェクト
49 */
50 public Object getPartActionObject();
51
52 /**
53 * {@link FormDesc} オブジェクトを取得します。<br />
54 *
55 * @return {@link FormDesc} オブジェクト
56 */
57 public FormDesc getFormDesc();
58
59 /**
60 * フォームクラスのオブジェクトを取得します。<br />
61 *
62 * @return フォームクラスのオブジェクト
63 */
64 public Object getFormObject();
65
66 /**
67 * {@link PartActionDesc} オブジェクトを設定します。<br />
68 *
69 * @param desc
70 * {@link PartActionDesc} オブジェクト
71 */
72 public void setPartActionDesc(PartActionDesc desc);
73
74 /**
75 * パートアクションクラスのオブジェクトを設定します。<br />
76 *
77 * @param object
78 * パートアクションクラスのオブジェクト
79 */
80 public void setPartActionObject(Object object);
81
82 /**
83 * {@link FormDesc} オブジェクトを設定します。<br />
84 *
85 * @param desc
86 * {@link FormDesc} オブジェクト
87 */
88 public void setFormDesc(FormDesc desc);
89
90 /**
91 * フォームクラスのオブジェクトを設定します。<br />
92 *
93 * @param object
94 * フォームクラスのオブジェクト
95 */
96 public void setFormObject(Object object);
97
98 /**
99 * 親 {@link WindowContext} を返します。<br />
100 *
101 * @return {@link WindowContext} オブジェクト
102 */
103 public WindowContext getWindowContext();
104 }