01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. See the NOTICE file distributed with
04: * this work for additional information regarding copyright ownership.
05: * The ASF licenses this file to You under the Apache License, Version 2.0
06: * (the "License"); you may not use this file except in compliance with
07: * the License. You may obtain a copy of the License at
08: *
09: * 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: package org.apache.beehive.controls.api.context;
20:
21: import org.apache.beehive.controls.api.events.EventRef;
22: import java.lang.reflect.InvocationTargetException;
23:
24: /**
25: * The ControlHandle interface defines a reference object to a control instance that enables
26: * control events to be fired on the control. Control container implementations will provide
27: * implementation of this interface that use container-specific dispatch mechanisms to locate
28: * the appropriate control container instance when events are fired.
29: *
30: * Classes implementing the ControlHandle interface should also implement the <code>
31: * java.io.Serializable</code> interface. This will enable handles to be serialized /
32: * deserialized as part of event queueing or routing.
33: */
34: public interface ControlHandle {
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,
45: InvocationTargetException;
46: }
|