01 /*
02 * Copyright 2008-2017 the original author or authors.
03 *
04 * Licensed under the Apache License, Version 2.0 (the "License");
05 * you may not use this file except in compliance with the License.
06 * You may obtain a copy of the License at
07 *
08 * http://www.apache.org/licenses/LICENSE-2.0
09 *
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, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16 package griffon.core.controller;
17
18 import griffon.core.artifact.GriffonController;
19
20 import javax.annotation.Nonnull;
21 import javax.annotation.Nullable;
22
23 /**
24 * @author Andres Almiray
25 * @since 2.0.0
26 */
27 public interface Action {
28 String KEY_ACTION_NAME = "actionName";
29 String KEY_NAME = "name";
30 String KEY_ENABLED = "enabled";
31
32 /**
33 * Returns the metadata of this action.
34 *
35 * @since 2.11.0
36 */
37 @Nonnull
38 ActionMetadata getActionMetadata();
39
40 @Nonnull
41 String getActionName();
42
43 /**
44 * Returns the fully qualified name of this action.</p>
45 * The value should be the controller's full class name and the action's name joined by a period.
46 *
47 * @return the fully qualified name of this action.
48 *
49 * @since 2.1.0
50 */
51 @Nonnull
52 String getFullyQualifiedName();
53
54 @Nullable
55 String getName();
56
57 void setName(@Nullable String name);
58
59 boolean isEnabled();
60
61 void setEnabled(boolean enabled);
62
63 @Nonnull
64 ActionManager getActionManager();
65
66 @Nonnull
67 GriffonController getController();
68
69 @Nonnull
70 Object getToolkitAction();
71
72 void execute(Object... args);
73
74 void initialize();
75 }
|