View Javadoc

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.core;
17  
18  import org.seasar.uruma.annotation.ApplicationContext;
19  import org.seasar.uruma.ui.UrumaApplicationWindow;
20  
21  /**
22   * ウィンドウを管理するクラスのためのインターフェースです。<br />
23   * 
24   * @author y-komori
25   * @author bskuroneko
26   */
27  public interface UrumaWindowManager {
28      /**
29       * 新しいウィンドウを開きます。<br />
30       * 
31       * @param templatePath
32       *            テンプレートパス
33       * @param modal
34       *            モーダル属性
35       * @return 生成したウィンドウ
36       */
37      public UrumaApplicationWindow openWindow(final String templatePath,
38              final boolean modal);
39  
40      /**
41       * 指定されたパスの画面定義 XML を読み込み、ダイアログを開きます。<br />
42       * ダイアログをオープンする前に、<code>parentAction</code> から {@link ApplicationContext}
43       * へ値がエクスポートされます。<br />
44       * 
45       * @param templatePath
46       *            画面定義 XML のパス
47       * @param parentAction
48       *            呼び出し元アクションクラスの
49       * @return リターンコード
50       */
51      public int openDialog(String templatePath, Object parentAction);
52  
53      /**
54       * <code>windowId</code> で指定されたIDのウィンドウを閉じます。<br />
55       * 
56       * @param windowId
57       *            ウィンドウのID
58       */
59      public void close(String windowId);
60  }