/* * Copyright (c) 2010, 2013, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as * published by the Free Software Foundation. Oracle designates this * particular file as subject to the "Classpath" exception as provided * by Oracle in the LICENSE file that accompanied this code. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License * version 2 for more details (a copy is included in the LICENSE file that * accompanied this code). * * You should have received a copy of the GNU General Public License version * 2 along with this work; if not, write to the Free Software Foundation, * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. * * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA * or visit www.oracle.com if you need additional information or have any * questions. */ package com.sun.javafx.scene.control.skin; import java.util.ArrayList; import java.util.Collections; import java.util.List; import com.sun.javafx.scene.traversal.Algorithm; import com.sun.javafx.scene.traversal.ParentTraversalEngine; import com.sun.javafx.scene.traversal.TraversalContext; import javafx.beans.property.ObjectProperty; import javafx.beans.property.DoubleProperty; import javafx.beans.value.WritableValue; import javafx.collections.FXCollections; import javafx.collections.ListChangeListener; import javafx.collections.ObservableList; import javafx.geometry.HPos; import javafx.geometry.Orientation; import javafx.geometry.Pos; import javafx.geometry.Side; import javafx.geometry.VPos; import javafx.scene.Node; import javafx.scene.Parent; import javafx.scene.accessibility.Action; import javafx.scene.accessibility.Attribute; import javafx.scene.accessibility.Role; import javafx.scene.control.ContextMenu; import javafx.scene.control.MenuItem; import javafx.scene.control.CustomMenuItem; import javafx.scene.control.Separator; import javafx.scene.control.SeparatorMenuItem; import javafx.scene.control.SkinBase; import javafx.scene.control.ToolBar; import javafx.scene.input.KeyCode; import javafx.scene.layout.HBox; import javafx.scene.layout.Pane; import javafx.scene.layout.StackPane; import javafx.scene.layout.VBox; import javafx.css.StyleableDoubleProperty; import javafx.css.StyleableObjectProperty; import javafx.css.StyleableProperty; import javafx.css.CssMetaData; import com.sun.javafx.css.converters.EnumConverter; import com.sun.javafx.css.converters.SizeConverter; import com.sun.javafx.scene.control.behavior.ToolBarBehavior; import com.sun.javafx.scene.traversal.Direction; import javafx.css.Styleable; import static com.sun.javafx.scene.control.skin.resources.ControlResources.getString; public class ToolBarSkin extends BehaviorSkinBase { private Pane box; private ToolBarOverflowMenu overflowMenu; private boolean overflow = false; private double previousWidth = 0; private double previousHeight = 0; private double savedPrefWidth = 0; private double savedPrefHeight = 0; private ObservableList overflowMenuItems; private boolean needsUpdate = false; private final ParentTraversalEngine engine; public ToolBarSkin(ToolBar toolbar) { super(toolbar, new ToolBarBehavior(toolbar)); overflowMenuItems = FXCollections.observableArrayList(); initialize(); registerChangeListener(toolbar.orientationProperty(), "ORIENTATION"); engine = new ParentTraversalEngine(getSkinnable(), new Algorithm() { private Node selectPrev(int from, TraversalContext context) { for (int i = from; i >= 0; --i) { Node n = box.getChildren().get(i); if (n.isDisabled() || !n.impl_isTreeVisible()) continue; if (n instanceof Parent) { Node selected = context.selectLastInParent((Parent)n); if (selected != null) return selected; } if (n.isFocusTraversable() ) { return n; } } return null; } private Node selectNext(int from, TraversalContext context) { for (int i = from, max = box.getChildren().size(); i < max; ++i) { Node n = box.getChildren().get(i); if (n.isDisabled() || !n.impl_isTreeVisible()) continue; if (n.isFocusTraversable()) { return n; } if (n instanceof Parent) { Node selected = context.selectFirstInParent((Parent)n); if (selected != null) return selected; } } return null; } @Override public Node select(Node owner, Direction dir, TraversalContext context) { final ObservableList boxChildren = box.getChildren(); if (owner == overflowMenu) { if (dir.isForward()) { return null; } else { Node selected = selectPrev(boxChildren.size() - 1, context); if (selected != null) return selected; } } int idx = boxChildren.indexOf(owner); if (idx < 0) { // The current focus owner is a child of some Toolbar's item Parent item = owner.getParent(); while (!boxChildren.contains(item)) { item = item.getParent(); } Node selected = context.selectInSubtree(item, owner, dir); if (selected != null) return selected; idx = boxChildren.indexOf(owner); if (dir == Direction.NEXT) dir = Direction.NEXT_IN_LINE; } if (idx >= 0) { if (dir.isForward()) { Node selected = selectNext(idx + 1, context); if (selected != null) return selected; if (overflow) { overflowMenu.requestFocus(); return overflowMenu; } } else { Node selected = selectPrev(idx - 1, context); if (selected != null) return selected; } } return null; } @Override public Node selectFirst(TraversalContext context) { Node selected = selectNext(0, context); if (selected != null) return selected; if (overflow) { return overflowMenu; } return null; } @Override public Node selectLast(TraversalContext context) { if (overflow) { return overflowMenu; } return selectPrev(box.getChildren().size() - 1, context); } }); getSkinnable().setImpl_traversalEngine(engine); toolbar.focusedProperty().addListener((observable, oldValue, newValue) -> { if (newValue) { // TODO need to detect the focus direction // to selected the first control in the toolbar when TAB is pressed // or select the last control in the toolbar when SHIFT TAB is pressed. if (!box.getChildren().isEmpty()) { box.getChildren().get(0).requestFocus(); } else { overflowMenu.requestFocus(); } } }); toolbar.getItems().addListener((ListChangeListener) c -> { while (c.next()) { for (Node n: c.getRemoved()) { box.getChildren().remove(n); } box.getChildren().addAll(c.getAddedSubList()); } needsUpdate = true; getSkinnable().requestLayout(); }); } private DoubleProperty spacing; public final void setSpacing(double value) { spacingProperty().set(snapSpace(value)); } public final double getSpacing() { return spacing == null ? 0.0 : snapSpace(spacing.get()); } public final DoubleProperty spacingProperty() { if (spacing == null) { spacing = new StyleableDoubleProperty() { @Override protected void invalidated() { final double value = get(); if (getSkinnable().getOrientation() == Orientation.VERTICAL) { ((VBox)box).setSpacing(value); } else { ((HBox)box).setSpacing(value); } } @Override public Object getBean() { return ToolBarSkin.this; } @Override public String getName() { return "spacing"; } @Override public CssMetaData getCssMetaData() { return StyleableProperties.SPACING; } }; } return spacing; } private ObjectProperty boxAlignment; public final void setBoxAlignment(Pos value) { boxAlignmentProperty().set(value); } public final Pos getBoxAlignment() { return boxAlignment == null ? Pos.TOP_LEFT : boxAlignment.get(); } public final ObjectProperty boxAlignmentProperty() { if (boxAlignment == null) { boxAlignment = new StyleableObjectProperty(Pos.TOP_LEFT) { @Override public void invalidated() { final Pos value = get(); if (getSkinnable().getOrientation() == Orientation.VERTICAL) { ((VBox)box).setAlignment(value); } else { ((HBox)box).setAlignment(value); } } @Override public Object getBean() { return ToolBarSkin.this; } @Override public String getName() { return "boxAlignment"; } @Override public CssMetaData getCssMetaData() { return StyleableProperties.ALIGNMENT; } }; } return boxAlignment; } @Override protected void handleControlPropertyChanged(String property) { super.handleControlPropertyChanged(property); if ("ORIENTATION".equals(property)) { initialize(); } } @Override protected double computeMinWidth(double height, double topInset, double rightInset, double bottomInset, double leftInset) { final ToolBar toolbar = getSkinnable(); return toolbar.getOrientation() == Orientation.VERTICAL ? computePrefWidth(-1, topInset, rightInset, bottomInset, leftInset) : snapSize(overflowMenu.prefWidth(-1)) + leftInset + rightInset; } @Override protected double computeMinHeight(double width, double topInset, double rightInset, double bottomInset, double leftInset) { final ToolBar toolbar = getSkinnable(); return toolbar.getOrientation() == Orientation.VERTICAL? snapSize(overflowMenu.prefHeight(-1)) + topInset + bottomInset : computePrefHeight(-1, topInset, rightInset, bottomInset, leftInset); } @Override protected double computePrefWidth(double height, double topInset, double rightInset, double bottomInset, double leftInset) { double prefWidth = 0; final ToolBar toolbar = getSkinnable(); if (toolbar.getOrientation() == Orientation.HORIZONTAL) { for (Node node : toolbar.getItems()) { prefWidth += snapSize(node.prefWidth(-1)) + getSpacing(); } prefWidth -= getSpacing(); } else { for (Node node : toolbar.getItems()) { prefWidth = Math.max(prefWidth, snapSize(node.prefWidth(-1))); } if (toolbar.getItems().size() > 0) { savedPrefWidth = prefWidth; } else { prefWidth = savedPrefWidth; } } return leftInset + prefWidth + rightInset; } @Override protected double computePrefHeight(double width, double topInset, double rightInset, double bottomInset, double leftInset) { double prefHeight = 0; final ToolBar toolbar = getSkinnable(); if(toolbar.getOrientation() == Orientation.VERTICAL) { for (Node node: toolbar.getItems()) { prefHeight += snapSize(node.prefHeight(-1)) + getSpacing(); } prefHeight -= getSpacing(); } else { for (Node node : toolbar.getItems()) { prefHeight = Math.max(prefHeight, snapSize(node.prefHeight(-1))); } if (toolbar.getItems().size() > 0) { savedPrefHeight = prefHeight; } else { prefHeight = savedPrefHeight; } } return topInset + prefHeight + bottomInset; } @Override protected double computeMaxWidth(double height, double topInset, double rightInset, double bottomInset, double leftInset) { return getSkinnable().getOrientation() == Orientation.VERTICAL ? snapSize(getSkinnable().prefWidth(-1)) : Double.MAX_VALUE; } @Override protected double computeMaxHeight(double width, double topInset, double rightInset, double bottomInset, double leftInset) { return getSkinnable().getOrientation() == Orientation.VERTICAL ? Double.MAX_VALUE : snapSize(getSkinnable().prefHeight(-1)); } @Override protected void layoutChildren(final double x,final double y, final double w, final double h) { // super.layoutChildren(); final ToolBar toolbar = getSkinnable(); if (toolbar.getOrientation() == Orientation.VERTICAL) { if (snapSize(toolbar.getHeight()) != previousHeight || needsUpdate) { ((VBox)box).setSpacing(getSpacing()); ((VBox)box).setAlignment(getBoxAlignment()); previousHeight = snapSize(toolbar.getHeight()); addNodesToToolBar(); } } else { if (snapSize(toolbar.getWidth()) != previousWidth || needsUpdate) { ((HBox)box).setSpacing(getSpacing()); ((HBox)box).setAlignment(getBoxAlignment()); previousWidth = snapSize(toolbar.getWidth()); addNodesToToolBar(); } } needsUpdate = false; double toolbarWidth = w; double toolbarHeight = h; if (getSkinnable().getOrientation() == Orientation.VERTICAL) { toolbarHeight -= (overflow ? snapSize(overflowMenu.prefHeight(-1)) : 0); } else { toolbarWidth -= (overflow ? snapSize(overflowMenu.prefWidth(-1)) : 0); } box.resize(toolbarWidth, toolbarHeight); positionInArea(box, x, y, toolbarWidth, toolbarHeight, /*baseline ignored*/0, HPos.CENTER, VPos.CENTER); // If popup menu is not null show the overflowControl if (overflow) { double overflowMenuWidth = snapSize(overflowMenu.prefWidth(-1)); double overflowMenuHeight = snapSize(overflowMenu.prefHeight(-1)); double overflowX = x; double overflowY = x; if (getSkinnable().getOrientation() == Orientation.VERTICAL) { // This is to prevent the overflow menu from moving when there // are no items in the toolbar. if (toolbarWidth == 0) { toolbarWidth = savedPrefWidth; } HPos pos = ((VBox)box).getAlignment().getHpos(); if (HPos.LEFT.equals(pos)) { overflowX = x + Math.abs((toolbarWidth - overflowMenuWidth)/2); } else if (HPos.RIGHT.equals(pos)) { overflowX = (snapSize(toolbar.getWidth()) - snappedRightInset() - toolbarWidth) + Math.abs((toolbarWidth - overflowMenuWidth)/2); } else { overflowX = x + Math.abs((snapSize(toolbar.getWidth()) - (x) + snappedRightInset() - overflowMenuWidth)/2); } overflowY = snapSize(toolbar.getHeight()) - overflowMenuHeight - y; } else { // This is to prevent the overflow menu from moving when there // are no items in the toolbar. if (toolbarHeight == 0) { toolbarHeight = savedPrefHeight; } VPos pos = ((HBox)box).getAlignment().getVpos(); if (VPos.TOP.equals(pos)) { overflowY = y + Math.abs((toolbarHeight - overflowMenuHeight)/2); } else if (VPos.BOTTOM.equals(pos)) { overflowY = (snapSize(toolbar.getHeight()) - snappedBottomInset() - toolbarHeight) + Math.abs((toolbarHeight - overflowMenuHeight)/2); } else { overflowY = y + Math.abs((toolbarHeight - overflowMenuHeight)/2); } overflowX = snapSize(toolbar.getWidth()) - overflowMenuWidth - snappedRightInset(); } overflowMenu.resize(overflowMenuWidth, overflowMenuHeight); positionInArea(overflowMenu, overflowX, overflowY, overflowMenuWidth, overflowMenuHeight, /*baseline ignored*/0, HPos.CENTER, VPos.CENTER); } } private void initialize() { if (getSkinnable().getOrientation() == Orientation.VERTICAL) { box = new VBox(); } else { box = new HBox(); } box.getStyleClass().add("container"); box.getChildren().addAll(getSkinnable().getItems()); overflowMenu = new ToolBarOverflowMenu(overflowMenuItems); overflowMenu.setVisible(false); overflowMenu.setManaged(false); getChildren().clear(); getChildren().add(box); getChildren().add(overflowMenu); previousWidth = 0; previousHeight = 0; savedPrefWidth = 0; savedPrefHeight = 0; needsUpdate = true; getSkinnable().requestLayout(); } private void addNodesToToolBar() { final ToolBar toolbar = getSkinnable(); double length = 0; if (getSkinnable().getOrientation() == Orientation.VERTICAL) { length = snapSize(toolbar.getHeight()) - snappedTopInset() - snappedBottomInset() + getSpacing(); } else { length = snapSize(toolbar.getWidth()) - snappedLeftInset() - snappedRightInset() + getSpacing(); } // Is there overflow ? double x = 0; boolean hasOverflow = false; for (Node node : getSkinnable().getItems()) { if (getSkinnable().getOrientation() == Orientation.VERTICAL) { x += snapSize(node.prefHeight(-1)) + getSpacing(); } else { x += snapSize(node.prefWidth(-1)) + getSpacing(); } if (x > length) { hasOverflow = true; break; } } if (hasOverflow) { if (getSkinnable().getOrientation() == Orientation.VERTICAL) { length -= snapSize(overflowMenu.prefHeight(-1)); } else { length -= snapSize(overflowMenu.prefWidth(-1)); } length -= getSpacing(); } // Determine which node goes to the toolbar and which goes to the overflow. x = 0; overflowMenuItems.clear(); box.getChildren().clear(); for (Node node : getSkinnable().getItems()) { node.getStyleClass().remove("menu-item"); node.getStyleClass().remove("custom-menu-item"); if (getSkinnable().getOrientation() == Orientation.VERTICAL) { x += snapSize(node.prefHeight(-1)) + getSpacing(); } else { x += snapSize(node.prefWidth(-1)) + getSpacing(); } if (x <= length) { box.getChildren().add(node); } else { if (node.isFocused()) { if (!box.getChildren().isEmpty()) { Node last = engine.selectLast(); if (last != null) { last.requestFocus(); } } else { overflowMenu.requestFocus(); } } if (node instanceof Separator) { overflowMenuItems.add(new SeparatorMenuItem()); } else { CustomMenuItem customMenuItem = new CustomMenuItem(node); // RT-36455: // We can't be totally certain of all nodes, but for the // most common nodes we can check to see whether we should // hide the menu when the node is clicked on. The common // case is for TextField or Slider. // This list won't be exhaustive (there is no point really // considering the ListView case), but it should try to // include most common control types that find themselves // placed in menus. final String nodeType = node.getTypeSelector(); switch (nodeType) { case "Button": case "Hyperlink": case "Label": customMenuItem.setHideOnClick(true); break; case "CheckBox": case "ChoiceBox": case "ColorPicker": case "ComboBox": case "DatePicker": case "MenuButton": case "PasswordField": case "RadioButton": case "ScrollBar": case "ScrollPane": case "Slider": case "SplitMenuButton": case "SplitPane": case "TextArea": case "TextField": case "ToggleButton": case "ToolBar": customMenuItem.setHideOnClick(false); break; } overflowMenuItems.add(customMenuItem); } } } // Check if we overflowed. overflow = overflowMenuItems.size() > 0; if (!overflow && overflowMenu.isFocused()) { Node last = engine.selectLast(); if (last != null) { last.requestFocus(); } } overflowMenu.setVisible(overflow); overflowMenu.setManaged(overflow); } class ToolBarOverflowMenu extends StackPane { private StackPane downArrow; private ContextMenu popup; private ObservableList menuItems; public ToolBarOverflowMenu(ObservableList items) { getStyleClass().setAll("tool-bar-overflow-button"); setFocusTraversable(true); this.menuItems = items; downArrow = new StackPane(); downArrow.getStyleClass().setAll("arrow"); downArrow.setOnMousePressed(me -> { fire(); }); setOnKeyPressed(ke -> { if (KeyCode.SPACE.equals(ke.getCode())) { if (!popup.isShowing()) { popup.getItems().clear(); popup.getItems().addAll(menuItems); popup.show(downArrow, Side.BOTTOM, 0, 0); } ke.consume(); } else if (KeyCode.ESCAPE.equals(ke.getCode())) { if (popup.isShowing()) { popup.hide(); } ke.consume(); } else if (KeyCode.ENTER.equals(ke.getCode())) { fire(); ke.consume(); } }); focusedProperty().addListener((observable, oldValue, newValue) -> { if (newValue) { if (!popup.isShowing()) { popup.getItems().clear(); popup.getItems().addAll(menuItems); popup.show(downArrow, Side.BOTTOM, 0, 0); } } else { if (popup.isShowing()) { popup.hide(); } } }); visibleProperty().addListener((observable, oldValue, newValue) -> { if (newValue) { if (box.getChildren().isEmpty()) { setFocusTraversable(true); } } }); popup = new ContextMenu(); setVisible(false); setManaged(false); getChildren().add(downArrow); } private void fire() { if (popup.isShowing()) { popup.hide(); } else { popup.getItems().clear(); popup.getItems().addAll(menuItems); popup.show(downArrow, Side.BOTTOM, 0, 0); } } @Override protected double computePrefWidth(double height) { return snappedLeftInset() + snappedRightInset(); } @Override protected double computePrefHeight(double width) { return snappedTopInset() + snappedBottomInset(); } @Override protected void layoutChildren() { double w = snapSize(downArrow.prefWidth(-1)); double h = snapSize(downArrow.prefHeight(-1)); double x = (snapSize(getWidth()) - w)/2; double y = (snapSize(getHeight()) - h)/2; // TODO need to provide support for when the toolbar is on the right // or bottom if (getSkinnable().getOrientation() == Orientation.VERTICAL) { downArrow.setRotate(0); } downArrow.resize(w, h); positionInArea(downArrow, x, y, w, h, /*baseline ignored*/0, HPos.CENTER, VPos.CENTER); } @Override public Object accGetAttribute(Attribute attribute, Object... parameters) { switch (attribute) { case ROLE: return Role.BUTTON; case TITLE: return getString("Accessibility.title.ToolBar.OverflowButton"); default: return super.accGetAttribute(attribute, parameters); } } @Override public void accExecuteAction(Action action, Object... parameters) { switch (action) { case FIRE: fire(); break; default: super.accExecuteAction(action); break; } } } /*************************************************************************** * * * Stylesheet Handling * * * **************************************************************************/ /** * Super-lazy instantiation pattern from Bill Pugh. * @treatAsPrivate implementation detail */ private static class StyleableProperties { private static final CssMetaData SPACING = new CssMetaData("-fx-spacing", SizeConverter.getInstance(), 0.0) { @Override public boolean isSettable(ToolBar n) { final ToolBarSkin skin = (ToolBarSkin) n.getSkin(); return skin.spacing == null || !skin.spacing.isBound(); } @Override public StyleableProperty getStyleableProperty(ToolBar n) { final ToolBarSkin skin = (ToolBarSkin) n.getSkin(); return (StyleableProperty)(WritableValue)skin.spacingProperty(); } }; private static final CssMetaDataALIGNMENT = new CssMetaData("-fx-alignment", new EnumConverter(Pos.class), Pos.TOP_LEFT ) { @Override public boolean isSettable(ToolBar n) { final ToolBarSkin skin = (ToolBarSkin) n.getSkin(); return skin.boxAlignment == null || !skin.boxAlignment.isBound(); } @Override public StyleableProperty getStyleableProperty(ToolBar n) { final ToolBarSkin skin = (ToolBarSkin) n.getSkin(); return (StyleableProperty)(WritableValue)skin.boxAlignmentProperty(); } }; private static final List> STYLEABLES; static { final List> styleables = new ArrayList>(SkinBase.getClassCssMetaData()); // StackPane also has -fx-alignment. Replace it with // ToolBarSkin's. // TODO: Really should be able to reference StackPane.StyleableProperties.ALIGNMENT final String alignmentProperty = ALIGNMENT.getProperty(); for (int n=0, nMax=styleables.size(); n prop = styleables.get(n); if (alignmentProperty.equals(prop.getProperty())) styleables.remove(prop); } styleables.add(SPACING); styleables.add(ALIGNMENT); STYLEABLES = Collections.unmodifiableList(styleables); } } /** * @return The CssMetaData associated with this class, which may include the * CssMetaData of its super classes. */ public static List> getClassCssMetaData() { return StyleableProperties.STYLEABLES; } /** * {@inheritDoc} */ @Override public List> getCssMetaData() { return getClassCssMetaData(); } @Override protected Object accGetAttribute(Attribute attribute, Object... parameters) { switch (attribute) { case OVERFLOW_BUTTON: return overflowMenu; default: return super.accGetAttribute(attribute, parameters); } } @Override protected void accExecuteAction(Action action, Object... parameters) { switch (action) { case SHOW_MENU: overflowMenu.fire(); break; default: super.accExecuteAction(action, parameters); } } }