JavaFXActionManager.java
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.javafx.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 
032 import static griffon.util.GriffonApplicationUtils.isMacOSX;
033 import static griffon.util.GriffonNameUtils.getNaturalName;
034 import static griffon.util.GriffonNameUtils.isNotBlank;
035 import static griffon.util.TypeUtils.castToBoolean;
036 
037 /**
038  @author Andres Almiray
039  @since 2.0.0
040  */
041 public class JavaFXActionManager extends AbstractActionManager {
042     private static final Logger LOG = LoggerFactory.getLogger(JavaFXActionManager.class);
043 
044     private static final String EMPTY_STRING = "";
045     private static final String DOT = ".";
046     private static final String EQUALS = " = ";
047     private static final String KEY_NAME = "name";
048     private static final String KEY_ACCELERATOR = "accelerator";
049     private static final String KEY_DESCRIPTION = "description";
050     private static final String KEY_ICON = "icon";
051     private static final String KEY_IMAGE = "image";
052     private static final String KEY_ENABLED = "enabled";
053     private static final String KEY_SELECTED = "selected";
054     private static final String KEY_VISIBLE = "visible";
055     private static final String KEY_STYLE_CLASS = "styleclass";
056     private static final String KEY_STYLE = "style";
057     private static final String KEY_GRAPHIC_STYLE_CLASS = "graphic_styleclass";
058     private static final String KEY_GRAPHIC_STYLE = "graphic_style";
059     private static final String KEY_CTRL = "ctrl";
060     private static final String KEY_META = "meta";
061     private static final String TRUE = "true";
062     private static final String FALSE = "false";
063 
064     @Inject
065     public JavaFXActionManager(@Nonnull GriffonApplication application, @Nonnull ActionFactory actionFactory, @Nonnull ActionMetadataFactory actionMetadataFactory) {
066         super(application, actionFactory, actionMetadataFactory);
067     }
068 
069     @Override
070     protected void doConfigureAction(@Nonnull final Action action, @Nonnull final GriffonController controller, @Nonnull final String normalizeNamed, @Nonnull final String keyPrefix) {
071         controller.getApplication().addPropertyChangeListener(GriffonApplication.PROPERTY_LOCALE, evt -> configureAction((JavaFXGriffonControllerActionaction, controller, normalizeNamed, keyPrefix));
072         configureAction((JavaFXGriffonControllerActionaction, controller, normalizeNamed, keyPrefix);
073     }
074 
075     protected void configureAction(@Nonnull JavaFXGriffonControllerAction action, @Nonnull GriffonController controller, @Nonnull String normalizeNamed, @Nonnull String keyPrefix) {
076         resolveName(action, controller, normalizeNamed, keyPrefix);
077         resolveAccelerator(action, controller, normalizeNamed, keyPrefix);
078         resolveDescription(action, controller, normalizeNamed, keyPrefix);
079         resolveIcon(action, controller, normalizeNamed, keyPrefix);
080         resolveImage(action, controller, normalizeNamed, keyPrefix);
081         resolveEnabled(action, controller, normalizeNamed, keyPrefix);
082         resolveSelected(action, controller, normalizeNamed, keyPrefix);
083         resolveVisible(action, controller, normalizeNamed, keyPrefix);
084         resolveStyleClass(action, controller, normalizeNamed, keyPrefix);
085         resolveStyle(action, controller, normalizeNamed, keyPrefix);
086         resolveGraphicStyleClass(action, controller, normalizeNamed, keyPrefix);
087         resolveGraphicStyle(action, controller, normalizeNamed, keyPrefix);
088     }
089 
090     protected void resolveName(@Nonnull JavaFXGriffonControllerAction 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 JavaFXGriffonControllerAction 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 resolveDescription(@Nonnull JavaFXGriffonControllerAction action, @Nonnull GriffonController controller, @Nonnull String normalizeNamed, @Nonnull String keyPrefix) {
111         String rsDescription = msg(keyPrefix, normalizeNamed, KEY_DESCRIPTION, EMPTY_STRING);
112         if (isNotBlank(rsDescription)) {
113             trace(keyPrefix + normalizeNamed, KEY_DESCRIPTION, rsDescription);
114             action.setDescription(rsDescription);
115         }
116     }
117 
118     protected void resolveIcon(@Nonnull JavaFXGriffonControllerAction action, @Nonnull GriffonController controller, @Nonnull String normalizeNamed, @Nonnull String keyPrefix) {
119         String rsIcon = msg(keyPrefix, normalizeNamed, KEY_ICON, EMPTY_STRING);
120         if (isNotBlank(rsIcon)) {
121             trace(keyPrefix + normalizeNamed, KEY_ICON, rsIcon);
122             action.setIcon(rsIcon);
123         }
124     }
125 
126     protected void resolveImage(@Nonnull JavaFXGriffonControllerAction action, @Nonnull GriffonController controller, @Nonnull String normalizeNamed, @Nonnull String keyPrefix) {
127         String rsImage = msg(keyPrefix, normalizeNamed, KEY_IMAGE, EMPTY_STRING);
128         if (isNotBlank(rsImage)) {
129             trace(keyPrefix + normalizeNamed, KEY_IMAGE, rsImage);
130             action.setImage(rsImage);
131         }
132     }
133 
134     protected void resolveEnabled(@Nonnull JavaFXGriffonControllerAction action, @Nonnull GriffonController controller, @Nonnull String normalizeNamed, @Nonnull String keyPrefix) {
135         String rsEnabled = msg(keyPrefix, normalizeNamed, KEY_ENABLED, TRUE);
136         if (isNotBlank(rsEnabled)) {
137             trace(keyPrefix + normalizeNamed, KEY_ENABLED, rsEnabled);
138             action.setEnabled(castToBoolean(rsEnabled));
139         }
140     }
141 
142     protected void resolveSelected(@Nonnull JavaFXGriffonControllerAction action, @Nonnull GriffonController controller, @Nonnull String normalizeNamed, @Nonnull String keyPrefix) {
143         String rsSelected = msg(keyPrefix, normalizeNamed, KEY_SELECTED, FALSE);
144         if (isNotBlank(rsSelected)) {
145             trace(keyPrefix + normalizeNamed, KEY_SELECTED, rsSelected);
146             action.setSelected(castToBoolean(rsSelected));
147         }
148     }
149 
150     protected void resolveVisible(@Nonnull JavaFXGriffonControllerAction action, @Nonnull GriffonController controller, @Nonnull String normalizeNamed, @Nonnull String keyPrefix) {
151         String rsVisible = msg(keyPrefix, normalizeNamed, KEY_VISIBLE, TRUE);
152         if (isNotBlank(rsVisible)) {
153             trace(keyPrefix + normalizeNamed, KEY_VISIBLE, rsVisible);
154             action.setVisible(castToBoolean(rsVisible));
155         }
156     }
157 
158     protected void resolveStyleClass(@Nonnull JavaFXGriffonControllerAction action, @Nonnull GriffonController controller, @Nonnull String normalizeNamed, @Nonnull String keyPrefix) {
159         String rsStyleClass = msg(keyPrefix, normalizeNamed, KEY_STYLE_CLASS, EMPTY_STRING);
160         if (isNotBlank(rsStyleClass)) {
161             trace(keyPrefix + normalizeNamed, KEY_STYLE_CLASS, rsStyleClass);
162             action.setStyleClass(rsStyleClass);
163         }
164     }
165 
166     protected void resolveStyle(@Nonnull JavaFXGriffonControllerAction action, @Nonnull GriffonController controller, @Nonnull String normalizeNamed, @Nonnull String keyPrefix) {
167         String rsStyle = msg(keyPrefix, normalizeNamed, KEY_STYLE, EMPTY_STRING);
168         if (isNotBlank(rsStyle)) {
169             trace(keyPrefix + normalizeNamed, KEY_STYLE, rsStyle);
170             action.setStyle(rsStyle);
171         }
172     }
173 
174     protected void resolveGraphicStyleClass(@Nonnull JavaFXGriffonControllerAction action, @Nonnull GriffonController controller, @Nonnull String normalizeNamed, @Nonnull String keyPrefix) {
175         String rsGraphicStyleClass = msg(keyPrefix, normalizeNamed, KEY_GRAPHIC_STYLE_CLASS, EMPTY_STRING);
176         if (isNotBlank(rsGraphicStyleClass)) {
177             trace(keyPrefix + normalizeNamed, KEY_GRAPHIC_STYLE_CLASS, rsGraphicStyleClass);
178             action.setGraphicStyleClass(rsGraphicStyleClass);
179         }
180     }
181 
182     protected void resolveGraphicStyle(@Nonnull JavaFXGriffonControllerAction action, @Nonnull GriffonController controller, @Nonnull String normalizeNamed, @Nonnull String keyPrefix) {
183         String rsGraphicStyle = msg(keyPrefix, normalizeNamed, KEY_GRAPHIC_STYLE, EMPTY_STRING);
184         if (isNotBlank(rsGraphicStyle)) {
185             trace(keyPrefix + normalizeNamed, KEY_GRAPHIC_STYLE, rsGraphicStyle);
186             action.setGraphicStyle(rsGraphicStyle);
187         }
188     }
189 
190     protected void trace(@Nonnull String actionKey, @Nonnull String key, @Nonnull String value) {
191         if (LOG.isTraceEnabled()) {
192             LOG.trace(actionKey + DOT + key + EQUALS + value);
193         }
194     }
195 }