001 /*
002 * Copyright 2008-2017 the original author or authors.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016 package org.codehaus.griffon.runtime.swing.controller;
017
018 import griffon.core.GriffonApplication;
019 import griffon.core.artifact.GriffonController;
020 import griffon.core.controller.Action;
021 import org.codehaus.griffon.runtime.core.controller.AbstractActionManager;
022 import org.slf4j.Logger;
023 import org.slf4j.LoggerFactory;
024
025 import javax.annotation.Nonnull;
026 import javax.inject.Inject;
027 import java.beans.PropertyChangeEvent;
028 import java.beans.PropertyChangeListener;
029
030 import static griffon.util.GriffonApplicationUtils.isMacOSX;
031 import static griffon.util.GriffonNameUtils.getNaturalName;
032 import static griffon.util.GriffonNameUtils.isBlank;
033 import static griffon.util.TypeUtils.castToBoolean;
034
035 /**
036 * @author Andres Almiray
037 * @since 2.0.0
038 */
039 public class SwingActionManager extends AbstractActionManager {
040 private static final Logger LOG = LoggerFactory.getLogger(SwingActionManager.class);
041 private static final String KEY_SELECTED = "selected";
042 private static final String KEY_ENABLED = "enabled";
043 private static final String KEY_LARGE_ICON = "large_icon";
044 private static final String KEY_SMALL_ICON = "small_icon";
045 private static final String KEY_LONG_DESCRIPTION = "long_description";
046 private static final String KEY_SHORT_DESCRIPTION = "short_description";
047 private static final String KEY_COMMAND = "command";
048 private static final String KEY_ACCELERATOR = "accelerator";
049 private static final String KEY_NAME = "name";
050 private static final String KEY_MNEMONIC = "mnemonic";
051 private static final String KEY_CTRL = "ctrl";
052 private static final String KEY_META = "meta";
053 private static final String EMPTY_STRING = "";
054 private static final String DOT = ".";
055 private static final String EQUALS = " = ";
056
057 @Inject
058 public SwingActionManager(@Nonnull GriffonApplication application) {
059 super(application);
060 }
061
062 @Nonnull
063 @Override
064 protected Action createControllerAction(@Nonnull GriffonController controller, @Nonnull String actionName) {
065 return new SwingGriffonControllerAction(getUiThreadManager(), this, controller, actionName);
066 }
067
068 @Override
069 protected void doConfigureAction(@Nonnull final Action action, @Nonnull final GriffonController controller, @Nonnull final String normalizeNamed, @Nonnull final String keyPrefix) {
070 controller.getApplication().addPropertyChangeListener(GriffonApplication.PROPERTY_LOCALE, new PropertyChangeListener() {
071 @Override
072 public void propertyChange(PropertyChangeEvent evt) {
073 configureAction((SwingGriffonControllerAction) action, controller, normalizeNamed, keyPrefix);
074 }
075 });
076 configureAction((SwingGriffonControllerAction) action, controller, normalizeNamed, keyPrefix);
077 }
078
079 protected void configureAction(@Nonnull SwingGriffonControllerAction action, @Nonnull GriffonController controller, @Nonnull String normalizeNamed, @Nonnull String keyPrefix) {
080 resolveName(action, controller, normalizeNamed, keyPrefix);
081 resolveAccelerator(action, controller, normalizeNamed, keyPrefix);
082 resolveCommand(action, controller, normalizeNamed, keyPrefix);
083 resolveShortDescription(action, controller, normalizeNamed, keyPrefix);
084 resolveLongDescription(action, controller, normalizeNamed, keyPrefix);
085 resolveMnemonic(action, controller, normalizeNamed, keyPrefix);
086 resolveSmallIcon(action, controller, normalizeNamed, keyPrefix);
087 resolveLargeIcon(action, controller, normalizeNamed, keyPrefix);
088 resolveEnabled(action, controller, normalizeNamed, keyPrefix);
089 resolveSelected(action, controller, normalizeNamed, keyPrefix);
090 }
091
092 protected void resolveName(@Nonnull SwingGriffonControllerAction action, @Nonnull GriffonController controller, @Nonnull String normalizeNamed, @Nonnull String keyPrefix) {
093 String rsActionName = msg(keyPrefix, normalizeNamed, KEY_NAME, getNaturalName(normalizeNamed));
094 if (!isBlank(rsActionName)) {
095 trace(keyPrefix + normalizeNamed, KEY_NAME, rsActionName);
096 action.setName(rsActionName);
097 }
098 }
099
100 protected void resolveAccelerator(@Nonnull SwingGriffonControllerAction action, @Nonnull GriffonController controller, @Nonnull String normalizeNamed, @Nonnull String keyPrefix) {
101 String rsAccelerator = msg(keyPrefix, normalizeNamed, KEY_ACCELERATOR, EMPTY_STRING);
102 if (!isBlank(rsAccelerator)) {
103 //noinspection ConstantConditions
104 if (!isMacOSX() && rsAccelerator.contains(KEY_META) && !rsAccelerator.contains(KEY_CTRL)) {
105 rsAccelerator = rsAccelerator.replace(KEY_META, KEY_CTRL);
106 }
107 trace(keyPrefix + normalizeNamed, KEY_ACCELERATOR, rsAccelerator);
108 action.setAccelerator(rsAccelerator);
109 }
110 }
111
112 protected void resolveCommand(@Nonnull SwingGriffonControllerAction action, @Nonnull GriffonController controller, @Nonnull String normalizeNamed, @Nonnull String keyPrefix) {
113 String rsCommand = msg(keyPrefix, normalizeNamed, KEY_COMMAND, EMPTY_STRING);
114 if (!isBlank(rsCommand)) {
115 trace(keyPrefix + normalizeNamed, KEY_COMMAND, rsCommand);
116 action.setCommand(rsCommand);
117 }
118 }
119
120 protected void resolveShortDescription(@Nonnull SwingGriffonControllerAction action, @Nonnull GriffonController controller, @Nonnull String normalizeNamed, @Nonnull String keyPrefix) {
121 String rsShortDescription = msg(keyPrefix, normalizeNamed, KEY_SHORT_DESCRIPTION, EMPTY_STRING);
122 if (!isBlank(rsShortDescription)) {
123 trace(keyPrefix + normalizeNamed, KEY_SHORT_DESCRIPTION, rsShortDescription);
124 action.setShortDescription(rsShortDescription);
125 }
126 }
127
128 protected void resolveLongDescription(@Nonnull SwingGriffonControllerAction action, @Nonnull GriffonController controller, @Nonnull String normalizeNamed, @Nonnull String keyPrefix) {
129 String rsLongDescription = msg(keyPrefix, normalizeNamed, KEY_LONG_DESCRIPTION, EMPTY_STRING);
130 if (!isBlank(rsLongDescription)) {
131 trace(keyPrefix + normalizeNamed, KEY_LONG_DESCRIPTION, rsLongDescription);
132 action.setLongDescription(rsLongDescription);
133 }
134 }
135
136 protected void resolveMnemonic(@Nonnull SwingGriffonControllerAction action, @Nonnull GriffonController controller, @Nonnull String normalizeNamed, @Nonnull String keyPrefix) {
137 String rsMnemonic = msg(keyPrefix, normalizeNamed, KEY_MNEMONIC, EMPTY_STRING);
138 if (!isBlank(rsMnemonic)) {
139 trace(keyPrefix + normalizeNamed, KEY_MNEMONIC, rsMnemonic);
140 action.setMnemonic(rsMnemonic);
141 }
142 }
143
144 protected void resolveSmallIcon(@Nonnull SwingGriffonControllerAction action, @Nonnull GriffonController controller, @Nonnull String normalizeNamed, @Nonnull String keyPrefix) {
145 String rsSmallIcon = msg(keyPrefix, normalizeNamed, KEY_SMALL_ICON, EMPTY_STRING);
146 if (!isBlank(rsSmallIcon)) {
147 trace(keyPrefix + normalizeNamed, KEY_SMALL_ICON, rsSmallIcon);
148 action.setSmallIcon(rsSmallIcon);
149 }
150 }
151
152 protected void resolveLargeIcon(@Nonnull SwingGriffonControllerAction action, @Nonnull GriffonController controller, @Nonnull String normalizeNamed, @Nonnull String keyPrefix) {
153 String rsLargeIcon = msg(keyPrefix, normalizeNamed, KEY_LARGE_ICON, EMPTY_STRING);
154 if (!isBlank(rsLargeIcon)) {
155 trace(keyPrefix + normalizeNamed, KEY_LARGE_ICON, rsLargeIcon);
156 action.setLargeIcon(rsLargeIcon);
157 }
158 }
159
160 protected void resolveEnabled(@Nonnull SwingGriffonControllerAction action, @Nonnull GriffonController controller, @Nonnull String normalizeNamed, @Nonnull String keyPrefix) {
161 String rsEnabled = msg(keyPrefix, normalizeNamed, KEY_ENABLED, "true");
162 if (!isBlank(rsEnabled)) {
163 trace(keyPrefix + normalizeNamed, KEY_ENABLED, rsEnabled);
164 action.setEnabled(castToBoolean(rsEnabled));
165 }
166 }
167
168 protected void resolveSelected(@Nonnull SwingGriffonControllerAction action, @Nonnull GriffonController controller, @Nonnull String normalizeNamed, @Nonnull String keyPrefix) {
169 String rsSelected = msg(keyPrefix, normalizeNamed, KEY_SELECTED, "false");
170 if (!isBlank(rsSelected)) {
171 trace(keyPrefix + normalizeNamed, KEY_SELECTED, rsSelected);
172 action.setSelected(castToBoolean(rsSelected));
173 }
174 }
175
176 protected void trace(@Nonnull String actionKey, @Nonnull String key, @Nonnull String value) {
177 if (LOG.isTraceEnabled()) {
178 LOG.trace(actionKey + DOT + key + EQUALS + value);
179 }
180 }
181 }
|