/*
* Copyright 2008-2017 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package griffon.javafx.support;
import griffon.core.GriffonApplication;
import griffon.core.artifact.GriffonController;
import griffon.core.controller.Action;
import griffon.core.controller.ActionManager;
import griffon.core.editors.ValueConversionException;
import griffon.core.i18n.MessageSource;
import griffon.exceptions.InstanceMethodInvocationException;
import griffon.javafx.collections.GriffonFXCollections;
import javafx.application.Platform;
import javafx.beans.property.Property;
import javafx.collections.ObservableList;
import javafx.collections.ObservableMap;
import javafx.collections.ObservableSet;
import javafx.event.ActionEvent;
import javafx.event.EventHandler;
import javafx.scene.Node;
import javafx.scene.Parent;
import javafx.scene.Scene;
import javafx.scene.control.Accordion;
import javafx.scene.control.ButtonBar;
import javafx.scene.control.ButtonBase;
import javafx.scene.control.CheckBox;
import javafx.scene.control.CheckMenuItem;
import javafx.scene.control.ContextMenu;
import javafx.scene.control.Control;
import javafx.scene.control.Labeled;
import javafx.scene.control.Menu;
import javafx.scene.control.MenuBar;
import javafx.scene.control.MenuItem;
import javafx.scene.control.RadioButton;
import javafx.scene.control.RadioMenuItem;
import javafx.scene.control.ScrollPane;
import javafx.scene.control.SplitPane;
import javafx.scene.control.Tab;
import javafx.scene.control.TabPane;
import javafx.scene.control.TitledPane;
import javafx.scene.control.ToggleButton;
import javafx.scene.control.ToolBar;
import javafx.scene.control.Tooltip;
import javafx.scene.image.Image;
import javafx.scene.image.ImageView;
import javafx.stage.Window;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import java.lang.reflect.Constructor;
import java.lang.reflect.InvocationTargetException;
import java.net.URL;
import java.util.Collection;
import java.util.LinkedHashSet;
import java.util.Map;
import java.util.Set;
import java.util.function.Predicate;
import static griffon.core.GriffonApplication.PROPERTY_LOCALE;
import static griffon.util.GriffonClassUtils.EMPTY_OBJECT_ARRAY;
import static griffon.util.GriffonClassUtils.getGetterName;
import static griffon.util.GriffonClassUtils.getPropertyValue;
import static griffon.util.GriffonClassUtils.invokeExactInstanceMethod;
import static griffon.util.GriffonClassUtils.invokeInstanceMethod;
import static griffon.util.GriffonNameUtils.isBlank;
import static griffon.util.GriffonNameUtils.requireNonBlank;
import static java.util.Objects.isNull;
import static java.util.Objects.requireNonNull;
/**
* @author Andres Almiray
*/
public final class JavaFXUtils {
private static final String ERROR_NODE_NULL = "Argument 'node' must not be null";
private static final String ERROR_CONTROL_NULL = "Argument 'control' must not be null";
private static final String ERROR_ACTION_NULL = "Argument 'action' must not be null";
private static final String ERROR_ICON_BLANK = "Argument 'iconUrl' must not be blank";
private static final String ERROR_ID_BLANK = "Argument 'id' must not be blank";
private static final String ERROR_URL_BLANK = "Argument 'url' must not be blank";
private static final String ERROR_KEY_BLANK = "Argument 'key' must not be blank";
private static final String ERROR_ARGS_BLANK = "Argument 'args' must not be blank";
private static final String ERROR_ROOT_NULL = "Argument 'root' must not be null";
private static final String ERROR_PREDICATE_NULL = "Argument 'predicate' must not be null";
private static final String ERROR_CONTROLLER_NULL = "Argument 'controller' must not be null";
private static final String ERROR_APPLICATION_NULL = "Argument 'application' must not be null";
private static final String PROPERTY_SUFFIX = "Property";
private static final String SUFFIX_KEY = "-KEY";
private static final String SUFFIX_ARGS = "-ARGS";
private static final String SUFFIX_DEFAULT_VALUE = "-DEFAULT_VALUE";
private static final ActionMatcher DEFAULT_ACTION_MATCHER = ActionMatcher.DEFAULT;
private JavaFXUtils() {
}
/**
* Finds out if an i18n {@code key} has been registered with the target {@code Node}, returning the key if found.
*
* @param node the target node on which the key may have been registered.
*
* @return the key registered with the target {@code Node} or {@code null} if not found.
*
* @since 2.9.0
*/
@Nullable
public static String getI18nKey(@Nonnull Labeled node) {
requireNonNull(node, ERROR_NODE_NULL);
return (String) node.getProperties().get(MessageSource.class.getName() + SUFFIX_KEY);
}
/**
* Associates an i18n arrays of arguments to a {@code node}.
* These arguments will be used alongside a key to resolve a message via the application's {@code MessageSource}.
*
* @param node the target node on which the key will be registered.
* @param args the array of arguments to be registered.
*
* @since 2.9.0
*/
public static void setI18nArgs(@Nonnull Labeled node, @Nullable String args) {
requireNonNull(node, ERROR_NODE_NULL);
requireNonBlank(args, ERROR_ARGS_BLANK);
node.getProperties().put(MessageSource.class.getName() + SUFFIX_ARGS, args);
}
/**
* Finds out if an {@code arguments array} has been registered with the target {@code Node}, returning the array if found.
*
* @param node the target node on which the arguments may have been registered.
*
* @return the arguments registered with the target {@code Node} or {@code null} if not found.
*
* @since 2.9.0
*/
@Nullable
public static String getI18nArgs(@Nonnull Labeled node) {
requireNonNull(node, ERROR_NODE_NULL);
return (String) node.getProperties().get(MessageSource.class.getName() + SUFFIX_ARGS);
}
/**
* Associates an default value {@code node}.
* The value will be used alongside a key to resolve a message via the application's {@code MessageSource}.
*
* @param node the target node on which the key will be registered.
* @param defaultValue the value to be registered.
*
* @since 2.9.0
*/
public static void setI18nDefaultValue(@Nonnull Labeled node, @Nullable String defaultValue) {
requireNonNull(node, ERROR_NODE_NULL);
node.getProperties().put(MessageSource.class.getName() + SUFFIX_DEFAULT_VALUE, defaultValue);
}
/**
* Finds out if a {@code default value} has been registered with the target {@code Node}, returning the value if found.
*
* @param node the target node on which the value may have been registered.
*
* @return the value registered with the target {@code Node} or {@code null} if not found.
*
* @since 2.9.0
*/
@Nullable
public static String getI18nDefaultValue(@Nonnull Labeled node) {
requireNonNull(node, ERROR_NODE_NULL);
return (String) node.getProperties().get(MessageSource.class.getName() + SUFFIX_DEFAULT_VALUE);
}
/**
* Associates an i18n key to a {@code node}. The key is used to resolve a message via the application's {@code MessageSource}.
*
* @param node the target node on which the key will be registered.
* @param key the message key to be registered.
*
* @since 2.9.0
*/
public static void setI18nKey(@Nonnull Tab node, @Nonnull String key) {
requireNonNull(node, ERROR_NODE_NULL);
requireNonBlank(key, ERROR_KEY_BLANK);
node.getProperties().put(MessageSource.class.getName() + SUFFIX_KEY, key);
}
/**
* Finds out if an i18n {@code key} has been registered with the target {@code Node}, returning the key if found.
*
* @param node the target node on which the key may have been registered.
*
* @return the key registered with the target {@code Node} or {@code null} if not found.
*
* @since 2.9.0
*/
@Nullable
public static String getI18nKey(@Nonnull Tab node) {
requireNonNull(node, ERROR_NODE_NULL);
return (String) node.getProperties().get(MessageSource.class.getName() + SUFFIX_KEY);
}
/**
* Associates an i18n arrays of arguments to a {@code node}.
* These arguments will be used alongside a key to resolve a message via the application's {@code MessageSource}.
*
* @param node the target node on which the key will be registered.
* @param args the array of arguments to be registered.
*
* @since 2.9.0
*/
public static void setI18nArgs(@Nonnull Tab node, @Nullable String args) {
requireNonNull(node, ERROR_NODE_NULL);
requireNonBlank(args, ERROR_ARGS_BLANK);
node.getProperties().put(MessageSource.class.getName() + SUFFIX_ARGS, args);
}
/**
* Finds out if an {@code arguments array} has been registered with the target {@code Node}, returning the array if found.
*
* @param node the target node on which the arguments may have been registered.
*
* @return the arguments registered with the target {@code Node} or {@code null} if not found.
*
* @since 2.9.0
*/
@Nullable
public static String getI18nArgs(@Nonnull Tab node) {
requireNonNull(node, ERROR_NODE_NULL);
return (String) node.getProperties().get(MessageSource.class.getName() + SUFFIX_ARGS);
}
/**
* Associates an default value {@code node}.
* The value will be used alongside a key to resolve a message via the application's {@code MessageSource}.
*
* @param node the target node on which the key will be registered.
* @param defaultValue the value to be registered.
*
* @since 2.9.0
*/
public static void setI18nDefaultValue(@Nonnull Tab node, @Nullable String defaultValue) {
requireNonNull(node, ERROR_NODE_NULL);
node.getProperties().put(MessageSource.class.getName() + SUFFIX_DEFAULT_VALUE, defaultValue);
}
/**
* Finds out if a {@code default value} has been registered with the target {@code Node}, returning the value if found.
*
* @param node the target node on which the value may have been registered.
*
* @return the value registered with the target {@code Node} or {@code null} if not found.
*
* @since 2.9.0
*/
@Nullable
public static String getI18nDefaultValue(@Nonnull Tab node) {
requireNonNull(node, ERROR_NODE_NULL);
return (String) node.getProperties().get(MessageSource.class.getName() + SUFFIX_DEFAULT_VALUE);
}
/**
* Associates an i18n key to a {@code node}. The key is used to resolve a message via the application's {@code MessageSource}.
*
* @param node the target node on which the key will be registered.
* @param key the message key to be registered.
*
* @since 2.9.0
*/
public static void setI18nKey(@Nonnull MenuItem node, @Nonnull String key) {
requireNonNull(node, ERROR_NODE_NULL);
requireNonBlank(key, ERROR_KEY_BLANK);
node.getProperties().put(MessageSource.class.getName() + SUFFIX_KEY, key);
}
/**
* Finds out if an i18n {@code key} has been registered with the target {@code Node}, returning the key if found.
*
* @param node the target node on which the key may have been registered.
*
* @return the key registered with the target {@code Node} or {@code null} if not found.
*
* @since 2.9.0
*/
@Nullable
public static String getI18nKey(@Nonnull MenuItem node) {
requireNonNull(node, ERROR_NODE_NULL);
return (String) node.getProperties().get(MessageSource.class.getName() + SUFFIX_KEY);
}
/**
* Associates an i18n arrays of arguments to a {@code node}.
* These arguments will be used alongside a key to resolve a message via the application's {@code MessageSource}.
*
* @param node the target node on which the key will be registered.
* @param args the array of arguments to be registered.
*
* @since 2.9.0
*/
public static void setI18nArgs(@Nonnull MenuItem node, @Nullable String args) {
requireNonNull(node, ERROR_NODE_NULL);
requireNonBlank(args, ERROR_ARGS_BLANK);
node.getProperties().put(MessageSource.class.getName() + SUFFIX_ARGS, args);
}
/**
* Finds out if an {@code arguments array} has been registered with the target {@code Node}, returning the array if found.
*
* @param node the target node on which the arguments may have been registered.
*
* @return the arguments registered with the target {@code Node} or {@code null} if not found.
*
* @since 2.9.0
*/
@Nullable
public static String getI18nArgs(@Nonnull MenuItem node) {
requireNonNull(node, ERROR_NODE_NULL);
return (String) node.getProperties().get(MessageSource.class.getName() + SUFFIX_ARGS);
}
/**
* Associates an default value {@code node}.
* The value will be used alongside a key to resolve a message via the application's {@code MessageSource}.
*
* @param node the target node on which the key will be registered.
* @param defaultValue the value to be registered.
*
* @since 2.9.0
*/
public static void setI18nDefaultValue(@Nonnull MenuItem node, @Nullable String defaultValue) {
requireNonNull(node, ERROR_NODE_NULL);
node.getProperties().put(MessageSource.class.getName() + SUFFIX_DEFAULT_VALUE, defaultValue);
}
/**
* Finds out if a {@code default value} has been registered with the target {@code Node}, returning the value if found.
*
* @param node the target node on which the value may have been registered.
*
* @return the value registered with the target {@code Node} or {@code null} if not found.
*
* @since 2.9.0
*/
@Nullable
public static String getI18nDefaultValue(@Nonnull MenuItem node) {
requireNonNull(node, ERROR_NODE_NULL);
return (String) node.getProperties().get(MessageSource.class.getName() + SUFFIX_DEFAULT_VALUE);
}
public static void connectMessageSource(@Nonnull Object node, @Nonnull GriffonApplication application) {
requireNonNull(node, ERROR_NODE_NULL);
requireNonNull(application, ERROR_APPLICATION_NULL);
findElements(node, arg -> (arg instanceof Labeled && !isBlank(getI18nKey((Labeled) arg))) ||
(arg instanceof Tab && !isBlank(getI18nKey((Tab) arg))) ||
(arg instanceof MenuItem && !isBlank(getI18nKey((MenuItem) arg))))
.forEach(element -> {
if (element instanceof Labeled) {
doConnectMessageSource((Labeled) element, application);
} else if (element instanceof Tab) {
doConnectMessageSource((Tab) element, application);
} else if (element instanceof MenuItem) {
doConnectMessageSource((MenuItem) element, application);
}
});
}
private static void doConnectMessageSource(@Nonnull final Labeled node, @Nonnull final GriffonApplication application) {
application.addPropertyChangeListener(PROPERTY_LOCALE, evt -> updateLabeled(node, application));
updateLabeled(node, application);
}
private static void doConnectMessageSource(@Nonnull final Tab node, @Nonnull final GriffonApplication application) {
application.addPropertyChangeListener(PROPERTY_LOCALE, evt -> updateLabeled(node, application));
updateLabeled(node, application);
}
private static void doConnectMessageSource(@Nonnull final MenuItem node, @Nonnull final GriffonApplication application) {
application.addPropertyChangeListener(PROPERTY_LOCALE, evt -> updateLabeled(node, application));
updateLabeled(node, application);
}
private static void updateLabeled(@Nonnull final Labeled node, @Nonnull final GriffonApplication application) {
runInsideUIThread(() -> {
String key = getI18nKey(node);
String args = getI18nArgs(node);
String defaultValue = getI18nDefaultValue(node);
Object[] argArray = isBlank(args) ? EMPTY_OBJECT_ARRAY : args.split(",");
if (isBlank(defaultValue)) {
node.setText(application.getMessageSource().getMessage(key, argArray, application.getLocale()));
} else {
node.setText(application.getMessageSource().getMessage(key, argArray, application.getLocale(), defaultValue));
}
});
}
private static void updateLabeled(@Nonnull final Tab node, @Nonnull final GriffonApplication application) {
runInsideUIThread(() -> {
String key = getI18nKey(node);
String args = getI18nArgs(node);
String defaultValue = getI18nDefaultValue(node);
Object[] argArray = isBlank(args) ? EMPTY_OBJECT_ARRAY : args.split(",");
if (isBlank(defaultValue)) {
node.setText(application.getMessageSource().getMessage(key, argArray, application.getLocale()));
} else {
node.setText(application.getMessageSource().getMessage(key, argArray, application.getLocale(), defaultValue));
}
});
}
private static void updateLabeled(@Nonnull final MenuItem node, @Nonnull final GriffonApplication application) {
runInsideUIThread(() -> {
String key = getI18nKey(node);
String args = getI18nArgs(node);
String defaultValue = getI18nDefaultValue(node);
Object[] argArray = isBlank(args) ? EMPTY_OBJECT_ARRAY : args.split(",");
if (isBlank(defaultValue)) {
node.setText(application.getMessageSource().getMessage(key, argArray, application.getLocale()));
} else {
node.setText(application.getMessageSource().getMessage(key, argArray, application.getLocale(), defaultValue));
}
});
}
/**
* Associates a {@code Action} with a target {@code Node}.
*
* @param node the target node on which the action will be registered.
* @param actionId the id of the action to be registered.
*
* @since 2.8.0
*/
public static void setGriffonActionId(@Nonnull Node node, @Nonnull String actionId) {
requireNonNull(node, ERROR_NODE_NULL);
requireNonBlank(actionId, ERROR_ID_BLANK);
node.getProperties().put(Action.class.getName(), actionId);
}
/**
* Finds out if an {@code Action} has been registered with the target {@code Node}, returning the action id if found.
*
* @param node the target node on which the action may have been registered.
*
* @return the name of the action registered with the target {@code Node} or {@code null} if not found.
*
* @since 2.8.0
*/
@Nullable
public static String getGriffonActionId(@Nonnull Node node) {
requireNonNull(node, ERROR_NODE_NULL);
return (String) node.getProperties().get(Action.class.getName());
}
/**
* Associates a {@code Action} with a target {@code MenuItem}.
*
* @param menuItem the target menuItem on which the action will be registered.
* @param actionId the id of the action to be registered.
*
* @since 2.8.0
*/
public static void setGriffonActionId(@Nonnull MenuItem menuItem, @Nonnull String actionId) {
requireNonNull(menuItem, ERROR_NODE_NULL);
requireNonBlank(actionId, ERROR_ID_BLANK);
menuItem.getProperties().put(Action.class.getName(), actionId);
}
/**
* Finds out if an {@code Action} has been registered with the target {@code MenuItem}, returning the action id if found.
*
* @param menuItem the target menuItem on which the action may have been registered.
*
* @return the name of the action registered with the target {@code MenuItem} or {@code null} if not found.
*
* @since 2.8.0
*/
@Nullable
public static String getGriffonActionId(@Nonnull MenuItem menuItem) {
requireNonNull(menuItem, ERROR_NODE_NULL);
return (String) menuItem.getProperties().get(Action.class.getName());
}
/**
* Wraps an <tt>ObservableList</tt>, publishing updates inside the UI thread.
*
* @param source the <tt>ObservableList</tt> to be wrapped
* @param <E> the list's parameter type.
*
* @return a new <tt>ObservableList</tt>
*
* @see GriffonFXCollections#uiThreadAwareObservableList
* @since 2.6.0
* @deprecated Use {@code GriffonFXCollections.uiThreadAwareObservableList} instead.
*/
@Deprecated
@Nonnull
public static <E> ObservableList<E> createJavaFXThreadProxyList(@Nonnull ObservableList<E> source) {
return GriffonFXCollections.uiThreadAwareObservableList(source);
}
/**
* Wraps an <tt>ObservableSet</tt>, publishing updates inside the UI thread.
*
* @param source the <tt>ObservableSet</tt> to be wrapped
* @param <E> the set's parameter type.
*
* @return a new <tt>ObservableSet</tt>
*
* @see GriffonFXCollections#uiThreadAwareObservableSet
* @since 2.9.0
* @deprecated Use {@code GriffonFXCollections.uiThreadAwareObservableSet} instead.
*/
@Deprecated
@Nonnull
public static <E> ObservableSet<E> createJavaFXThreadProxySet(@Nonnull ObservableSet<E> source) {
return GriffonFXCollections.uiThreadAwareObservableSet(source);
}
/**
* Wraps an <tt>ObservableMap</tt>, publishing updates inside the UI thread.
*
* @param source the <tt>ObservableMap</tt> to be wrapped
* @param <K> the type of keys maintained by the map
* @param <V> the type of mapped values
*
* @return a new <tt>ObservableMap</tt>
*
* @see GriffonFXCollections#uiThreadAwareObservableMap
* @since 2.9.0
* @deprecated Use {@code GriffonFXCollections.uiThreadAwareObservableMap} instead.
*/
@Deprecated
@Nonnull
public static <K, V> ObservableMap<K, V> createJavaFXThreadProxyMap(@Nonnull ObservableMap<K, V> source) {
return GriffonFXCollections.uiThreadAwareObservableMap(source);
}
@Nonnull
@SuppressWarnings("ConstantConditions")
public static <B> Property<?> extractProperty(@Nonnull B bean, @Nonnull String propertyName) {
requireNonNull(bean, "Argument 'bean' must not be null");
requireNonBlank(propertyName, "Argument 'propertyName' must not be null");
if (!propertyName.endsWith(PROPERTY_SUFFIX)) {
propertyName += PROPERTY_SUFFIX;
}
InstanceMethodInvocationException imie;
try {
// 1. try <columnName>Property() first
return (Property<?>) invokeExactInstanceMethod(bean, propertyName);
} catch (InstanceMethodInvocationException e) {
imie = e;
}
// 2. fallback to get<columnName>Property()
try {
return (Property<?>) invokeExactInstanceMethod(bean, getGetterName(propertyName));
} catch (InstanceMethodInvocationException e) {
throw imie;
}
}
public static void connectActions(@Nonnull Object node, @Nonnull GriffonController controller, @Nonnull ActionMatcher actionMatcher) {
requireNonNull(node, ERROR_NODE_NULL);
requireNonNull(controller, ERROR_CONTROLLER_NULL);
actionMatcher = actionMatcher != null ? actionMatcher : DEFAULT_ACTION_MATCHER;
ActionManager actionManager = controller.getApplication().getActionManager();
for (Map.Entry<String, Action> e : actionManager.actionsFor(controller).entrySet()) {
String actionName = actionManager.normalizeName(e.getKey());
JavaFXAction action = (JavaFXAction) e.getValue().getToolkitAction();
actionMatcher.match(node, actionName, action);
}
}
public static void connectActions(@Nonnull Object node, @Nonnull GriffonController controller) {
connectActions(node, controller, DEFAULT_ACTION_MATCHER);
}
public static void configureControl(@Nonnull Object control, @Nonnull JavaFXAction action) {
if (control instanceof ButtonBase) {
configure(((ButtonBase) control), action);
} else if (control instanceof MenuItem) {
JavaFXUtils.configure(((MenuItem) control), action);
} else if (control instanceof Node) {
((Node) control).addEventHandler(ActionEvent.ACTION, wrapAction(action));
} else {
// does it support the onAction property?
try {
invokeInstanceMethod(control, "setOnAction", wrapAction(action));
} catch (InstanceMethodInvocationException imie) {
// ignore
}
}
}
private static EventHandler<ActionEvent> wrapAction(@Nonnull final JavaFXAction action) {
return event -> {
if (action.isEnabled()) {
action.getOnAction().handle(event);
}
};
}
private static void runInsideUIThread(@Nonnull Runnable runnable) {
if (Platform.isFxApplicationThread()) {
runnable.run();
} else {
Platform.runLater(runnable);
}
}
public static String normalizeStyle(@Nonnull String style, @Nonnull String key, @Nonnull String value) {
requireNonBlank(style, "Argument 'style' must not be blank");
requireNonBlank(key, "Argument 'key' must not be blank");
requireNonBlank(value, "Argument 'value' must not be blank");
int start = style.indexOf(key);
if (start != -1) {
int end = style.indexOf(";", start);
end = end >= start ? end : style.length() - 1;
style = style.substring(0, start) + style.substring(end + 1);
}
return style + key + ": " + value + ";";
}
public static void configure(@Nonnull final ToggleButton control, @Nonnull final JavaFXAction action) {
configure((ButtonBase) control, action);
action.selectedProperty().addListener((v, o, n) -> runInsideUIThread(() -> control.setSelected(n)));
runInsideUIThread(() -> control.setSelected(action.isSelected()));
}
public static void configure(@Nonnull final CheckBox control, @Nonnull final JavaFXAction action) {
configure((ButtonBase) control, action);
action.selectedProperty().addListener((v, o, n) -> runInsideUIThread(() -> control.setSelected(n)));
runInsideUIThread(() -> control.setSelected(action.isSelected()));
}
public static void configure(@Nonnull final RadioButton control, @Nonnull final JavaFXAction action) {
configure((ButtonBase) control, action);
action.selectedProperty().addListener((v, o, n) -> runInsideUIThread(() -> control.setSelected(n)));
runInsideUIThread(() -> control.setSelected(action.isSelected()));
}
public static void configure(@Nonnull final ButtonBase control, @Nonnull final JavaFXAction action) {
requireNonNull(control, ERROR_CONTROL_NULL);
requireNonNull(action, ERROR_ACTION_NULL);
action.onActionProperty().addListener((v, o, n) -> control.setOnAction(n));
control.setOnAction(action.getOnAction());
action.nameProperty().addListener((v, o, n) -> runInsideUIThread(() -> control.setText(n)));
runInsideUIThread(() -> control.setText(action.getName()));
action.descriptionProperty().addListener((v, o, n) -> setTooltip(control, n));
setTooltip(control, action.getDescription());
action.iconProperty().addListener((v, o, n) -> setIcon(control, n));
if (!isBlank(action.getIcon())) {
setIcon(control, action.getIcon());
}
action.imageProperty().addListener((v, o, n) -> setGraphic(control, n));
if (null != action.getImage()) {
setGraphic(control, action.getImage());
}
action.graphicProperty().addListener((v, o, n) -> setGraphic(control, n));
if (null != action.getGraphic()) {
setGraphic(control, action.getGraphic());
}
action.enabledProperty().addListener((v, o, n) -> runInsideUIThread(() -> control.setDisable(!n)));
runInsideUIThread(() -> control.setDisable(!action.isEnabled()));
action.visibleProperty().addListener((v, o, n) -> runInsideUIThread(() -> control.setVisible(n)));
runInsideUIThread(() -> control.setVisible(action.isVisible()));
action.styleClassProperty().addListener((v, o, n) -> {
setStyleClass(control, o, true);
setStyleClass(control, n);
});
setStyleClass(control, action.getStyleClass());
action.styleProperty().addListener((v, o, n) -> setStyle(control, n));
setStyle(control, action.getStyle());
action.graphicStyleClassProperty().addListener((v, o, n) -> {
setGraphicStyleClass(control, o, true);
setGraphicStyleClass(control, n);
});
setGraphicStyleClass(control, action.getGraphicStyleClass());
action.graphicStyleProperty().addListener((v, o, n) -> setGraphicStyle(control, n));
setGraphicStyle(control, action.getGraphicStyle());
}
public static void configure(@Nonnull final CheckMenuItem control, @Nonnull final JavaFXAction action) {
configure((MenuItem) control, action);
action.selectedProperty().addListener((v, o, n) -> runInsideUIThread(() -> control.setSelected(n)));
runInsideUIThread(() -> control.setSelected(action.isSelected()));
}
public static void configure(@Nonnull final RadioMenuItem control, @Nonnull final JavaFXAction action) {
configure((MenuItem) control, action);
action.selectedProperty().addListener((v, o, n) -> runInsideUIThread(() -> control.setSelected(n)));
runInsideUIThread(() -> control.setSelected(action.isSelected()));
}
public static void configure(@Nonnull final MenuItem control, @Nonnull final JavaFXAction action) {
requireNonNull(control, ERROR_CONTROL_NULL);
requireNonNull(action, ERROR_ACTION_NULL);
action.onActionProperty().addListener((v, o, n) -> control.setOnAction(n));
control.setOnAction(action.getOnAction());
action.nameProperty().addListener((v, o, n) -> runInsideUIThread(() -> control.setText(n)));
runInsideUIThread(() -> control.setText(action.getName()));
action.iconProperty().addListener((v, o, n) -> setIcon(control, n));
if (!isBlank(action.getIcon())) {
setIcon(control, action.getIcon());
}
action.imageProperty().addListener((v, o, n) -> setGraphic(control, n));
if (null != action.getImage()) {
setGraphic(control, action.getImage());
}
action.graphicProperty().addListener((v, o, n) -> setGraphic(control, n));
if (null != action.getGraphic()) {
setGraphic(control, action.getGraphic());
}
action.enabledProperty().addListener((v, o, n) -> runInsideUIThread(() -> control.setDisable(!n)));
runInsideUIThread(() -> control.setDisable(!action.getEnabled()));
action.acceleratorProperty().addListener((v, o, n) -> runInsideUIThread(() -> control.setAccelerator(n)));
runInsideUIThread(() -> control.setAccelerator(action.getAccelerator()));
action.visibleProperty().addListener((v, o, n) -> runInsideUIThread(() -> control.setVisible(n)));
runInsideUIThread(() -> control.setVisible(action.isVisible()));
action.styleClassProperty().addListener((v, o, n) -> {
setStyleClass(control, o, true);
setStyleClass(control, n);
});
setStyleClass(control, action.getStyleClass());
action.styleProperty().addListener((v, o, n) -> setStyle(control, n));
setStyle(control, action.getStyle());
action.graphicStyleClassProperty().addListener((v, o, n) -> {
setGraphicStyleClass(control, o, true);
setGraphicStyleClass(control, n);
});
setGraphicStyleClass(control, action.getGraphicStyleClass());
action.graphicStyleProperty().addListener((v, o, n) -> setGraphicStyle(control, n));
setGraphicStyle(control, action.getGraphicStyle());
}
public static void setStyle(@Nonnull Node node, @Nonnull String style) {
requireNonNull(node, ERROR_CONTROL_NULL);
if (isNull(style)) { return; }
if (style.startsWith("&")) {
// append style
String nodeStyle = node.getStyle();
node.setStyle(nodeStyle + (nodeStyle.endsWith(";") ? "" : ";") + style.substring(1));
} else {
node.setStyle(style);
}
}
public static void setStyle(@Nonnull MenuItem node, @Nonnull String style) {
requireNonNull(node, ERROR_CONTROL_NULL);
if (isNull(style)) { return; }
if (style.startsWith("&")) {
// append style
String nodeStyle = node.getStyle();
node.setStyle(nodeStyle + (nodeStyle.endsWith(";") ? "" : ";") + style.substring(1));
} else {
node.setStyle(style);
}
}
public static void setGraphicStyle(@Nonnull ButtonBase node, @Nonnull String graphicStyle) {
requireNonNull(node, ERROR_CONTROL_NULL);
if (isNull(graphicStyle)) { return; }
if (node.getGraphic() != null) {
setStyle(node.getGraphic(), graphicStyle);
}
}
public static void setGraphicStyle(@Nonnull MenuItem node, @Nonnull String graphicStyle) {
requireNonNull(node, ERROR_CONTROL_NULL);
if (isNull(graphicStyle)) { return; }
if (node.getGraphic() != null) {
setStyle(node.getGraphic(), graphicStyle);
}
}
public static void setStyleClass(@Nonnull Node node, @Nonnull String styleClass) {
setStyleClass(node, styleClass, false);
}
public static void setStyleClass(@Nonnull Node node, @Nonnull String styleClass, boolean remove) {
requireNonNull(node, ERROR_CONTROL_NULL);
if (isBlank(styleClass)) { return; }
ObservableList<String> styleClasses = node.getStyleClass();
applyStyleClass(styleClass, styleClasses, remove);
}
public static void setStyleClass(@Nonnull MenuItem node, @Nonnull String styleClass) {
setStyleClass(node, styleClass, false);
}
public static void setStyleClass(@Nonnull MenuItem node, @Nonnull String styleClass, boolean remove) {
requireNonNull(node, ERROR_CONTROL_NULL);
if (isBlank(styleClass)) { return; }
ObservableList<String> styleClasses = node.getStyleClass();
applyStyleClass(styleClass, styleClasses, remove);
}
public static void setGraphicStyleClass(@Nonnull ButtonBase node, @Nonnull String graphicStyleClass) {
setGraphicStyleClass(node, graphicStyleClass, false);
}
public static void setGraphicStyleClass(@Nonnull ButtonBase node, @Nonnull String graphicStyleClass, boolean remove) {
requireNonNull(node, ERROR_CONTROL_NULL);
if (isBlank(graphicStyleClass) || node.getGraphic() == null) { return; }
ObservableList<String> graphicStyleClasses = node.getGraphic().getStyleClass();
applyStyleClass(graphicStyleClass, graphicStyleClasses, remove);
}
public static void setGraphicStyleClass(@Nonnull MenuItem node, @Nonnull String graphicStyleClass) {
setGraphicStyleClass(node, graphicStyleClass, false);
}
public static void setGraphicStyleClass(@Nonnull MenuItem node, @Nonnull String graphicStyleClass, boolean remove) {
requireNonNull(node, ERROR_CONTROL_NULL);
if (isBlank(graphicStyleClass) || node.getGraphic() == null) { return; }
ObservableList<String> graphicStyleClasses = node.getGraphic().getStyleClass();
applyStyleClass(graphicStyleClass, graphicStyleClasses, remove);
}
private static void applyStyleClass(String styleClass, ObservableList<String> styleClasses, boolean remove) {
runInsideUIThread(() -> {
String[] strings = styleClass.split("[,\\ ]");
if (remove) {
styleClasses.removeAll(strings);
} else {
Set<String> classes = new LinkedHashSet<>(styleClasses);
for (String s : strings) {
if (isBlank(s)) { continue; }
classes.add(s.trim());
}
styleClasses.setAll(classes);
}
});
}
public static void setTooltip(@Nonnull Control control, @Nullable String text) {
runInsideUIThread(() -> {
if (isBlank(text)) {
return;
}
requireNonNull(control, ERROR_CONTROL_NULL);
Tooltip tooltip = control.tooltipProperty().get();
if (tooltip == null) {
tooltip = new Tooltip();
control.tooltipProperty().set(tooltip);
}
tooltip.setText(text);
});
}
public static void setIcon(@Nonnull Labeled control, @Nonnull String iconUrl) {
requireNonNull(control, ERROR_CONTROL_NULL);
requireNonBlank(iconUrl, ERROR_ICON_BLANK);
Node graphicNode = resolveIcon(iconUrl);
if (graphicNode != null) {
runInsideUIThread(() -> control.graphicProperty().set(graphicNode));
}
}
public static void setIcon(@Nonnull MenuItem control, @Nonnull String iconUrl) {
requireNonNull(control, ERROR_CONTROL_NULL);
requireNonBlank(iconUrl, ERROR_ICON_BLANK);
Node graphicNode = resolveIcon(iconUrl);
if (graphicNode != null) {
runInsideUIThread(() -> control.graphicProperty().set(graphicNode));
}
}
public static void setGraphic(@Nonnull Labeled control, @Nullable Image graphic) {
requireNonNull(control, ERROR_CONTROL_NULL);
runInsideUIThread(() -> {
if (graphic != null) {
Node graphicNode = new ImageView(graphic);
control.graphicProperty().set(graphicNode);
} else {
control.graphicProperty().set(null);
}
});
}
public static void setGraphic(@Nonnull MenuItem control, @Nullable Image graphic) {
requireNonNull(control, ERROR_CONTROL_NULL);
runInsideUIThread(() -> {
if (graphic != null) {
Node graphicNode = new ImageView(graphic);
control.graphicProperty().set(graphicNode);
} else {
control.graphicProperty().set(null);
}
});
}
public static void setGraphic(@Nonnull Labeled control, @Nullable Node graphic) {
requireNonNull(control, ERROR_CONTROL_NULL);
runInsideUIThread(() -> {
if (graphic != null) {
control.graphicProperty().set(graphic);
} else {
control.graphicProperty().set(null);
}
});
}
public static void setGraphic(@Nonnull MenuItem control, @Nullable Node graphic) {
requireNonNull(control, ERROR_CONTROL_NULL);
runInsideUIThread(() -> {
if (graphic != null) {
control.graphicProperty().set(graphic);
} else {
control.graphicProperty().set(null);
}
});
}
@Nullable
public static Node resolveIcon(@Nonnull String iconUrl) {
requireNonBlank(iconUrl, ERROR_URL_BLANK);
if (iconUrl.contains("|")) {
// assume classname|arg format
return handleAsClassWithArg(iconUrl);
} else {
URL resource = Thread.currentThread().getContextClassLoader().getResource(iconUrl);
if (resource != null) {
return new ImageView(new Image(resource.toString()));
}
}
return null;
}
@SuppressWarnings("unchecked")
private static Node handleAsClassWithArg(String str) {
String[] args = str.split("\\|");
if (args.length == 2) {
Class<?> iconClass = null;
try {
iconClass = (Class<?>) JavaFXUtils.class.getClassLoader().loadClass(args[0]);
} catch (ClassNotFoundException e) {
throw illegalValue(str, Node.class, e);
}
Constructor<?> constructor = null;
try {
constructor = iconClass.getConstructor(String.class);
} catch (NoSuchMethodException e) {
throw illegalValue(str, Node.class, e);
}
try {
Object o = constructor.newInstance(args[1]);
if (o instanceof Node) {
return (Node) o;
} else if (o instanceof Image) {
return new ImageView((Image) o);
} else {
throw illegalValue(str, Node.class);
}
} catch (InstantiationException | InvocationTargetException | IllegalAccessException e) {
throw illegalValue(str, Node.class, e);
}
} else {
throw illegalValue(str, Node.class);
}
}
@Nullable
public static Node findNode(@Nonnull Node root, @Nonnull String id) {
requireNonNull(root, ERROR_ROOT_NULL);
requireNonBlank(id, ERROR_ID_BLANK);
if (id.equals(root.getId())) { return root; }
if (root instanceof TabPane) {
TabPane parent = (TabPane) root;
for (Tab child : parent.getTabs()) {
if (child.getContent() != null) {
Node found = findNode(child.getContent(), id);
if (found != null) { return found; }
}
}
} else if (root instanceof TitledPane) {
TitledPane parent = (TitledPane) root;
if (parent.getContent() != null) {
Node found = findNode(parent.getContent(), id);
if (found != null) { return found; }
}
} else if (root instanceof Accordion) {
Accordion parent = (Accordion) root;
for (TitledPane child : parent.getPanes()) {
Node found = findNode(child, id);
if (found != null) { return found; }
}
} else if (root instanceof SplitPane) {
SplitPane parent = (SplitPane) root;
for (Node child : parent.getItems()) {
Node found = findNode(child, id);
if (found != null) { return found; }
}
} else if (root instanceof ScrollPane) {
ScrollPane scrollPane = (ScrollPane) root;
if (scrollPane.getContent() != null) {
Node found = findNode(scrollPane.getContent(), id);
if (found != null) { return found; }
}
} else if (root instanceof ToolBar) {
ToolBar toolBar = (ToolBar) root;
for (Node child : toolBar.getItems()) {
Node found = findNode(child, id);
if (found != null) { return found; }
}
} else if (root instanceof ButtonBar) {
ButtonBar buttonBar = (ButtonBar) root;
for (Node child : buttonBar.getButtons()) {
Node found = findNode(child, id);
if (found != null) { return found; }
}
} else if (root instanceof Parent) {
Parent parent = (Parent) root;
for (Node child : parent.getChildrenUnmodifiable()) {
Node found = findNode(child, id);
if (found != null) { return found; }
}
}
return null;
}
@Nullable
public static Object findElement(@Nonnull Object root, @Nonnull String id) {
requireNonNull(root, ERROR_ROOT_NULL);
requireNonBlank(id, ERROR_ID_BLANK);
if (id.equals(getPropertyValue(root, "id"))) { return root; }
if (root instanceof Control) {
Control control = (Control) root;
ContextMenu contextMenu = control.getContextMenu();
if (contextMenu != null) {
Object found = findElement(contextMenu, id);
if (found != null) {return found;}
}
Tooltip tooltip = control.getTooltip();
if (tooltip != null) {
Object found = findElement(tooltip, id);
if (found != null) {return found;}
}
}
if (root instanceof ButtonBar) {
ButtonBar buttonBar = (ButtonBar) root;
for (Node child : buttonBar.getButtons()) {
Object found = findElement(child, id);
if (found != null) { return found; }
}
} else if (root instanceof MenuBar) {
MenuBar menuBar = (MenuBar) root;
for (Menu child : menuBar.getMenus()) {
Object found = findElement(child, id);
if (found != null) { return found; }
}
} else if (root instanceof ContextMenu) {
ContextMenu contextMenu = (ContextMenu) root;
for (MenuItem child : contextMenu.getItems()) {
Object found = findElement(child, id);
if (found != null) { return found; }
}
} else if (root instanceof Menu) {
Menu menu = (Menu) root;
for (MenuItem child : menu.getItems()) {
Object found = findElement(child, id);
if (found != null) { return found; }
}
} else if (root instanceof TabPane) {
TabPane tabPane = (TabPane) root;
for (Tab child : tabPane.getTabs()) {
Object found = findElement(child, id);
if (found != null) { return found; }
}
} else if (root instanceof Tab) {
Tab tab = (Tab) root;
if (tab.getContent() != null) {
Object found = findElement(tab.getContent(), id);
if (found != null) { return found; }
}
} else if (root instanceof TitledPane) {
TitledPane parent = (TitledPane) root;
if (parent.getContent() != null) {
Object found = findElement(parent.getContent(), id);
if (found != null) { return found; }
}
} else if (root instanceof Accordion) {
Accordion parent = (Accordion) root;
for (TitledPane child : parent.getPanes()) {
Object found = findElement(child, id);
if (found != null) { return found; }
}
} else if (root instanceof SplitPane) {
SplitPane parent = (SplitPane) root;
for (Node child : parent.getItems()) {
Object found = findElement(child, id);
if (found != null) { return found; }
}
} else if (root instanceof ScrollPane) {
ScrollPane scrollPane = (ScrollPane) root;
if (scrollPane.getContent() != null) {
Object found = findElement(scrollPane.getContent(), id);
if (found != null) { return found; }
}
} else if (root instanceof ToolBar) {
ToolBar toolBar = (ToolBar) root;
for (Node child : toolBar.getItems()) {
Object found = findElement(child, id);
if (found != null) { return found; }
}
} else if (root instanceof Parent) {
Parent parent = (Parent) root;
for (Node child : parent.getChildrenUnmodifiable()) {
Object found = findElement(child, id);
if (found != null) { return found; }
}
}
return null;
}
@Nullable
public static Object findElement(@Nonnull Object root, @Nonnull Predicate<Object> predicate) {
requireNonNull(root, ERROR_ROOT_NULL);
requireNonNull(predicate, ERROR_PREDICATE_NULL);
if (predicate.test(root)) {
return root;
}
if (root instanceof Control) {
Control control = (Control) root;
ContextMenu contextMenu = control.getContextMenu();
if (contextMenu != null) {
Object found = findElement(contextMenu, predicate);
if (found != null) {return found;}
}
Tooltip tooltip = control.getTooltip();
if (tooltip != null) {
Object found = findElement(tooltip, predicate);
if (found != null) {return found;}
}
}
if (root instanceof ButtonBar) {
ButtonBar buttonBar = (ButtonBar) root;
for (Node child : buttonBar.getButtons()) {
Object found = findElement(child, predicate);
if (found != null) { return found; }
}
} else if (root instanceof MenuBar) {
MenuBar menuBar = (MenuBar) root;
for (Menu child : menuBar.getMenus()) {
Object found = findElement(child, predicate);
if (found != null) { return found; }
}
} else if (root instanceof ContextMenu) {
ContextMenu contextMenu = (ContextMenu) root;
for (MenuItem child : contextMenu.getItems()) {
Object found = findElement(child, predicate);
if (found != null) { return found; }
}
} else if (root instanceof Menu) {
Menu menu = (Menu) root;
for (MenuItem child : menu.getItems()) {
Object found = findElement(child, predicate);
if (found != null) { return found; }
}
} else if (root instanceof TabPane) {
TabPane tabPane = (TabPane) root;
for (Tab child : tabPane.getTabs()) {
Object found = findElement(child, predicate);
if (found != null) { return found; }
}
} else if (root instanceof Tab) {
Tab tab = (Tab) root;
if (tab.getContent() != null) {
Object found = findElement(tab.getContent(), predicate);
if (found != null) { return found; }
}
} else if (root instanceof TitledPane) {
TitledPane parent = (TitledPane) root;
if (parent.getContent() != null) {
Object found = findElement(parent.getContent(), predicate);
if (found != null) { return found; }
}
} else if (root instanceof Accordion) {
Accordion parent = (Accordion) root;
for (TitledPane child : parent.getPanes()) {
Object found = findElement(child, predicate);
if (found != null) { return found; }
}
} else if (root instanceof SplitPane) {
SplitPane parent = (SplitPane) root;
for (Node child : parent.getItems()) {
Object found = findElement(child, predicate);
if (found != null) { return found; }
}
} else if (root instanceof ScrollPane) {
ScrollPane scrollPane = (ScrollPane) root;
if (scrollPane.getContent() != null) {
Object found = findElement(scrollPane.getContent(), predicate);
if (found != null) { return found; }
}
} else if (root instanceof ToolBar) {
ToolBar toolBar = (ToolBar) root;
for (Node child : toolBar.getItems()) {
Object found = findElement(child, predicate);
if (found != null) { return found; }
}
} else if (root instanceof Parent) {
Parent parent = (Parent) root;
for (Node child : parent.getChildrenUnmodifiable()) {
Object found = findElement(child, predicate);
if (found != null) { return found; }
}
}
return null;
}
@Nonnull
public static Collection<Object> findElements(@Nonnull Object root, @Nonnull Predicate<Object> predicate) {
Set<Object> accumulator = new LinkedHashSet<>();
findElements(root, predicate, accumulator);
return accumulator;
}
private static void findElements(@Nonnull Object root, @Nonnull Predicate<Object> predicate, @Nonnull Collection<Object> accumulator) {
requireNonNull(root, ERROR_ROOT_NULL);
requireNonNull(predicate, ERROR_PREDICATE_NULL);
if (predicate.test(root)) {
accumulator.add(root);
}
if (root instanceof Control) {
Control control = (Control) root;
ContextMenu contextMenu = control.getContextMenu();
if (contextMenu != null) {
findElements(contextMenu, predicate, accumulator);
}
Tooltip tooltip = control.getTooltip();
if (tooltip != null) {
findElements(tooltip, predicate, accumulator);
}
}
if (root instanceof ButtonBar) {
ButtonBar buttonBar = (ButtonBar) root;
for (Node child : buttonBar.getButtons()) {
findElements(child, predicate, accumulator);
}
} else if (root instanceof MenuBar) {
MenuBar menuBar = (MenuBar) root;
for (Menu child : menuBar.getMenus()) {
findElements(child, predicate, accumulator);
}
} else if (root instanceof ContextMenu) {
ContextMenu contextMenu = (ContextMenu) root;
for (MenuItem child : contextMenu.getItems()) {
findElements(child, predicate, accumulator);
}
} else if (root instanceof Menu) {
Menu menu = (Menu) root;
for (MenuItem child : menu.getItems()) {
findElements(child, predicate, accumulator);
}
} else if (root instanceof TabPane) {
TabPane tabPane = (TabPane) root;
for (Tab child : tabPane.getTabs()) {
findElements(child, predicate, accumulator);
}
} else if (root instanceof Tab) {
Tab tab = (Tab) root;
if (tab.getContent() != null) {
findElements(tab.getContent(), predicate, accumulator);
}
} else if (root instanceof TitledPane) {
TitledPane parent = (TitledPane) root;
if (parent.getContent() != null) {
findElements(parent.getContent(), predicate, accumulator);
}
} else if (root instanceof Accordion) {
Accordion parent = (Accordion) root;
for (TitledPane child : parent.getPanes()) {
findElements(child, predicate, accumulator);
}
} else if (root instanceof SplitPane) {
SplitPane parent = (SplitPane) root;
for (Node child : parent.getItems()) {
findElements(child, predicate, accumulator);
}
} else if (root instanceof ScrollPane) {
ScrollPane scrollPane = (ScrollPane) root;
if (scrollPane.getContent() != null) {
findElements(scrollPane.getContent(), predicate, accumulator);
}
} else if (root instanceof ToolBar) {
ToolBar toolBar = (ToolBar) root;
for (Node child : toolBar.getItems()) {
findElements(child, predicate, accumulator);
}
} else if (root instanceof Parent) {
Parent parent = (Parent) root;
for (Node child : parent.getChildrenUnmodifiable()) {
findElements(child, predicate, accumulator);
}
}
}
@Nullable
public static Window getWindowAncestor(@Nonnull Object node) {
requireNonNull(node, ERROR_NODE_NULL);
if (node instanceof Window) {
return (Window) node;
} else if (node instanceof Scene) {
return ((Scene) node).getWindow();
} else if (node instanceof Node) {
Scene scene = ((Node) node).getScene();
if (scene != null) {
return scene.getWindow();
}
} else if (node instanceof Tab) {
TabPane tabPane = ((Tab) node).getTabPane();
if (tabPane != null) {
return getWindowAncestor(tabPane);
}
}
return null;
}
private static ValueConversionException illegalValue(Object value, Class<?> klass) {
throw new ValueConversionException(value, klass);
}
private static ValueConversionException illegalValue(Object value, Class<?> klass, Exception e) {
throw new ValueConversionException(value, klass, e);
}
}