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.rcp.configuration.elements;
17  
18  import org.eclipse.core.commands.IHandler;
19  import org.seasar.uruma.annotation.ConfigurationAttribute;
20  import org.seasar.uruma.rcp.configuration.ConfigurationElement;
21  import org.seasar.uruma.util.AssertionUtil;
22  
23  /**
24   * <code>handler</code> 要素のための {@link ConfigurationElement} です。<br />
25   * 
26   * @author y-komori
27   * @see <a
28   *      href="http://help.eclipse.org/help33/topic/org.eclipse.platform.doc.isv/reference/extension-points/org_eclipse_ui_handlers.html#e.handler">handler</a>
29   */
30  public class HandlerElement extends AbstractConfigurationElementContainer {
31      /**
32       * 要素名です。<br />
33       */
34      public static final String ELEMENT_NAME = "handler";
35  
36      /**
37       * ハンドラの対応するコマンド ID です。<br />
38       */
39      @ConfigurationAttribute(required = true)
40      public String commandId;
41  
42      /**
43       * {@link IHandler} を実装したハンドラのクラスです。<br />
44       */
45      @ConfigurationAttribute(name = "class")
46      public String clazz;
47  
48      /**
49       * ハンドラのヘルプコンテクスト ID です。<br />
50       */
51      @ConfigurationAttribute
52      public String helpContextId;
53  
54      /**
55       * {@link HandlerElement} を構築します。<br />
56       */
57      public HandlerElement(final String commandId) {
58          super();
59          AssertionUtil.assertNotNull("commandId", commandId);
60          this.commandId = commandId;
61      }
62  }