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 griffon.core.controller.ActionFactory;
022 import griffon.core.controller.ActionMetadataFactory;
023 import org.codehaus.griffon.runtime.core.controller.AbstractActionManager;
024 import org.slf4j.Logger;
025 import org.slf4j.LoggerFactory;
026
027 import javax.annotation.Nonnull;
028 import javax.inject.Inject;
029 import java.beans.PropertyChangeEvent;
030 import java.beans.PropertyChangeListener;
031
032 import static griffon.util.GriffonApplicationUtils.isMacOSX;
033 import static griffon.util.GriffonNameUtils.getNaturalName;
034 import static griffon.util.GriffonNameUtils.isBlank;
035 import static griffon.util.TypeUtils.castToBoolean;
036
037 /**
038 * @author Andres Almiray
039 * @since 2.0.0
040 */
041 public class SwingActionManager extends AbstractActionManager {
042 private static final Logger LOG = LoggerFactory.getLogger(SwingActionManager.class);
043 private static final String KEY_SELECTED = "selected";
044 private static final String KEY_ENABLED = "enabled";
045 private static final String KEY_LARGE_ICON = "large_icon";
046 private static final String KEY_SMALL_ICON = "small_icon";
047 private static final String KEY_LONG_DESCRIPTION = "long_description";
048 private static final String KEY_SHORT_DESCRIPTION = "short_description";
049 private static final String KEY_COMMAND = "command";
050 private static final String KEY_ACCELERATOR = "accelerator";
051 private static final String KEY_NAME = "name";
052 private static final String KEY_MNEMONIC = "mnemonic";
053 private static final String KEY_CTRL = "ctrl";
054 private static final String KEY_META = "meta";
055 private static final String EMPTY_STRING = "";
056 private static final String DOT = ".";
057 private static final String EQUALS = " = ";
058
059 @Inject
060 public SwingActionManager(@Nonnull GriffonApplication application, @Nonnull ActionFactory actionFactory, @Nonnull ActionMetadataFactory actionMetadataFactory) {
061 super(application, actionFactory, actionMetadataFactory);
062 }
063
064 @Override
065 protected void doConfigureAction(@Nonnull final Action action, @Nonnull final GriffonController controller, @Nonnull final String normalizeNamed, @Nonnull final String keyPrefix) {
066 controller.getApplication().addPropertyChangeListener(GriffonApplication.PROPERTY_LOCALE, new PropertyChangeListener() {
067 @Override
068 public void propertyChange(PropertyChangeEvent evt) {
069 configureAction((SwingGriffonControllerAction) action, controller, normalizeNamed, keyPrefix);
070 }
071 });
072 configureAction((SwingGriffonControllerAction) action, controller, normalizeNamed, keyPrefix);
073 }
074
075 protected void configureAction(@Nonnull SwingGriffonControllerAction action, @Nonnull GriffonController controller, @Nonnull String normalizeNamed, @Nonnull String keyPrefix) {
076 resolveName(action, controller, normalizeNamed, keyPrefix);
077 resolveAccelerator(action, controller, normalizeNamed, keyPrefix);
078 resolveCommand(action, controller, normalizeNamed, keyPrefix);
079 resolveShortDescription(action, controller, normalizeNamed, keyPrefix);
080 resolveLongDescription(action, controller, normalizeNamed, keyPrefix);
081 resolveMnemonic(action, controller, normalizeNamed, keyPrefix);
082 resolveSmallIcon(action, controller, normalizeNamed, keyPrefix);
083 resolveLargeIcon(action, controller, normalizeNamed, keyPrefix);
084 resolveEnabled(action, controller, normalizeNamed, keyPrefix);
085 resolveSelected(action, controller, normalizeNamed, keyPrefix);
086 }
087
088 protected void resolveName(@Nonnull SwingGriffonControllerAction action, @Nonnull GriffonController controller, @Nonnull String normalizeNamed, @Nonnull String keyPrefix) {
089 String rsActionName = msg(keyPrefix, normalizeNamed, KEY_NAME, getNaturalName(normalizeNamed));
090 if (!isBlank(rsActionName)) {
091 trace(keyPrefix + normalizeNamed, KEY_NAME, rsActionName);
092 action.setName(rsActionName);
093 }
094 }
095
096 protected void resolveAccelerator(@Nonnull SwingGriffonControllerAction action, @Nonnull GriffonController controller, @Nonnull String normalizeNamed, @Nonnull String keyPrefix) {
097 String rsAccelerator = msg(keyPrefix, normalizeNamed, KEY_ACCELERATOR, EMPTY_STRING);
098 if (!isBlank(rsAccelerator)) {
099 //noinspection ConstantConditions
100 if (!isMacOSX() && rsAccelerator.contains(KEY_META) && !rsAccelerator.contains(KEY_CTRL)) {
101 rsAccelerator = rsAccelerator.replace(KEY_META, KEY_CTRL);
102 }
103 trace(keyPrefix + normalizeNamed, KEY_ACCELERATOR, rsAccelerator);
104 action.setAccelerator(rsAccelerator);
105 }
106 }
107
108 protected void resolveCommand(@Nonnull SwingGriffonControllerAction action, @Nonnull GriffonController controller, @Nonnull String normalizeNamed, @Nonnull String keyPrefix) {
109 String rsCommand = msg(keyPrefix, normalizeNamed, KEY_COMMAND, EMPTY_STRING);
110 if (!isBlank(rsCommand)) {
111 trace(keyPrefix + normalizeNamed, KEY_COMMAND, rsCommand);
112 action.setCommand(rsCommand);
113 }
114 }
115
116 protected void resolveShortDescription(@Nonnull SwingGriffonControllerAction action, @Nonnull GriffonController controller, @Nonnull String normalizeNamed, @Nonnull String keyPrefix) {
117 String rsShortDescription = msg(keyPrefix, normalizeNamed, KEY_SHORT_DESCRIPTION, EMPTY_STRING);
118 if (!isBlank(rsShortDescription)) {
119 trace(keyPrefix + normalizeNamed, KEY_SHORT_DESCRIPTION, rsShortDescription);
120 action.setShortDescription(rsShortDescription);
121 }
122 }
123
124 protected void resolveLongDescription(@Nonnull SwingGriffonControllerAction action, @Nonnull GriffonController controller, @Nonnull String normalizeNamed, @Nonnull String keyPrefix) {
125 String rsLongDescription = msg(keyPrefix, normalizeNamed, KEY_LONG_DESCRIPTION, EMPTY_STRING);
126 if (!isBlank(rsLongDescription)) {
127 trace(keyPrefix + normalizeNamed, KEY_LONG_DESCRIPTION, rsLongDescription);
128 action.setLongDescription(rsLongDescription);
129 }
130 }
131
132 protected void resolveMnemonic(@Nonnull SwingGriffonControllerAction action, @Nonnull GriffonController controller, @Nonnull String normalizeNamed, @Nonnull String keyPrefix) {
133 String rsMnemonic = msg(keyPrefix, normalizeNamed, KEY_MNEMONIC, EMPTY_STRING);
134 if (!isBlank(rsMnemonic)) {
135 trace(keyPrefix + normalizeNamed, KEY_MNEMONIC, rsMnemonic);
136 action.setMnemonic(rsMnemonic);
137 }
138 }
139
140 protected void resolveSmallIcon(@Nonnull SwingGriffonControllerAction action, @Nonnull GriffonController controller, @Nonnull String normalizeNamed, @Nonnull String keyPrefix) {
141 String rsSmallIcon = msg(keyPrefix, normalizeNamed, KEY_SMALL_ICON, EMPTY_STRING);
142 if (!isBlank(rsSmallIcon)) {
143 trace(keyPrefix + normalizeNamed, KEY_SMALL_ICON, rsSmallIcon);
144 action.setSmallIcon(rsSmallIcon);
145 }
146 }
147
148 protected void resolveLargeIcon(@Nonnull SwingGriffonControllerAction action, @Nonnull GriffonController controller, @Nonnull String normalizeNamed, @Nonnull String keyPrefix) {
149 String rsLargeIcon = msg(keyPrefix, normalizeNamed, KEY_LARGE_ICON, EMPTY_STRING);
150 if (!isBlank(rsLargeIcon)) {
151 trace(keyPrefix + normalizeNamed, KEY_LARGE_ICON, rsLargeIcon);
152 action.setLargeIcon(rsLargeIcon);
153 }
154 }
155
156 protected void resolveEnabled(@Nonnull SwingGriffonControllerAction action, @Nonnull GriffonController controller, @Nonnull String normalizeNamed, @Nonnull String keyPrefix) {
157 String rsEnabled = msg(keyPrefix, normalizeNamed, KEY_ENABLED, "true");
158 if (!isBlank(rsEnabled)) {
159 trace(keyPrefix + normalizeNamed, KEY_ENABLED, rsEnabled);
160 action.setEnabled(castToBoolean(rsEnabled));
161 }
162 }
163
164 protected void resolveSelected(@Nonnull SwingGriffonControllerAction action, @Nonnull GriffonController controller, @Nonnull String normalizeNamed, @Nonnull String keyPrefix) {
165 String rsSelected = msg(keyPrefix, normalizeNamed, KEY_SELECTED, "false");
166 if (!isBlank(rsSelected)) {
167 trace(keyPrefix + normalizeNamed, KEY_SELECTED, rsSelected);
168 action.setSelected(castToBoolean(rsSelected));
169 }
170 }
171
172 protected void trace(@Nonnull String actionKey, @Nonnull String key, @Nonnull String value) {
173 if (LOG.isTraceEnabled()) {
174 LOG.trace(actionKey + DOT + key + EQUALS + value);
175 }
176 }
177 }
|