ControlHandle


1   package org.apache.beehive.controls.api.context;
2   /*
3    * Copyright 2004 The Apache Software Foundation.
4    *
5    * Licensed under the Apache License, Version 2.0 (the "License");
6    * you may not use this file except in compliance with the License.
7    * You may obtain a copy of the License at
8    * 
9    *     http://www.apache.org/licenses/LICENSE-2.0
10   * 
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   *
17   * $Header:$
18   */
19  
20  import org.apache.beehive.controls.api.events.EventRef;
21  import java.lang.reflect.InvocationTargetException  ;
22  
23  /**
24   * The ControlHandle interface defines a reference object to a control instance that enables
25   * control events to be fired on the control.  Control container implementations will provide
26   * implementation of this interface that use container-specific dispatch mechanisms to locate
27   * the appropriate control container instance when events are fired.
28   * 
29   * Classes implementing the ControlHandle interface should also implement the <code>
30   * java.io.Serializable</code> interface.  This will enable handles to be serialized /
31   * deserialized as part of event queueing or routing.
32   */
33  public interface ControlHandle
34  {
35      /**
36       * Returns the controlID of the target control referenced by this handle
37       */
38      public String   getControlID();
39  
40      /**
41       * Delivers the specified event to the target control referenced by this handle.
42       */
43      public Object   sendEvent(EventRef event, Object   [] args) 
44                    throws IllegalAccessException  ,IllegalArgumentException  ,InvocationTargetException  ;
45  }
46
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags