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