impl.org.controlsfx.skin.BreadCrumbBarSkin Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of controlsfx Show documentation
Show all versions of controlsfx Show documentation
High quality UI controls and other tools to complement the core JavaFX distribution
/**
* Copyright (c) 2014, 2016 ControlsFX
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* * Neither the name of ControlsFX, any associated website, nor the
* names of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL CONTROLSFX BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package impl.org.controlsfx.skin;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import impl.org.controlsfx.ReflectionUtils;
import javafx.beans.InvalidationListener;
import javafx.beans.Observable;
import javafx.beans.property.ObjectProperty;
import javafx.beans.property.SimpleObjectProperty;
import javafx.beans.value.ChangeListener;
import javafx.event.Event;
import javafx.event.EventHandler;
import javafx.scene.Node;
import javafx.scene.control.Button;
import javafx.scene.control.SkinBase;
import javafx.scene.control.TreeItem;
import javafx.scene.control.TreeItem.TreeModificationEvent;
import javafx.scene.paint.Color;
import javafx.scene.shape.ArcTo;
import javafx.scene.shape.ClosePath;
import javafx.scene.shape.HLineTo;
import javafx.scene.shape.LineTo;
import javafx.scene.shape.MoveTo;
import javafx.scene.shape.Path;
import javafx.util.Callback;
import org.controlsfx.control.BreadCrumbBar;
import org.controlsfx.control.BreadCrumbBar.BreadCrumbActionEvent;
import com.sun.javafx.scene.traversal.Algorithm;
import com.sun.javafx.scene.traversal.Direction;
import com.sun.javafx.scene.traversal.ParentTraversalEngine;
import com.sun.javafx.scene.traversal.TraversalContext;
/**
* Basic Skin implementation for the {@link BreadCrumbBar}
*
* @param
*/
public class BreadCrumbBarSkin extends SkinBase> {
private static final String STYLE_CLASS_FIRST = "first"; //$NON-NLS-1$
public BreadCrumbBarSkin(final BreadCrumbBar control) {
super(control);
control.selectedCrumbProperty().addListener(selectedPathChangeListener);
updateSelectedPath(getSkinnable().selectedCrumbProperty().get(), null);
fixFocusTraversal();
}
// https://bitbucket.org/controlsfx/controlsfx/issue/453/breadcrumbbar-keyboard-focus-traversal-is
// ContainerTabOrder will fail with LEFT/RIGHT navigation, since the buttons in bread crumb overlap
private void fixFocusTraversal() {
ParentTraversalEngine engine = new ParentTraversalEngine(getSkinnable(), new Algorithm() {
@Override
public Node select(Node owner, Direction dir, TraversalContext context) {
Node node = null;
int idx = getChildren().indexOf(owner);
switch(dir) {
case NEXT:
case NEXT_IN_LINE:
case RIGHT:
if (idx < getChildren().size() - 1) {
node = getChildren().get(idx+1);
}
break;
case PREVIOUS:
case LEFT:
if (idx > 0) {
node = getChildren().get(idx-1);
}
break;
}
return node;
}
@Override
public Node selectFirst(TraversalContext context) {
Node first = null;
if (!getChildren().isEmpty()) {
first = getChildren().get(0);
}
return first;
}
@Override
public Node selectLast(TraversalContext context) {
Node last = null;
if (!getChildren().isEmpty()) {
last = getChildren().get(getChildren().size()-1);
}
return last;
}
});
engine.setOverriddenFocusTraversability(false);
ReflectionUtils.setTraversalEngine(getSkinnable(), engine);
}
private final ChangeListener> selectedPathChangeListener =
(obs, oldItem, newItem) -> updateSelectedPath(newItem, oldItem);
private void updateSelectedPath(TreeItem newTarget, TreeItem oldTarget) {
if(oldTarget != null){
// remove old listener
oldTarget.removeEventHandler(
TreeItem.childrenModificationEvent(), treeChildrenModifiedHandler);
}
if(newTarget != null){
// add new listener
newTarget.addEventHandler(TreeItem.childrenModificationEvent(), treeChildrenModifiedHandler);
}
updateBreadCrumbs();
}
private final EventHandler> treeChildrenModifiedHandler =
args -> updateBreadCrumbs();
private void updateBreadCrumbs() {
final BreadCrumbBar buttonBar = getSkinnable();
final TreeItem pathTarget = buttonBar.getSelectedCrumb();
final Callback, Button> factory = buttonBar.getCrumbFactory();
getChildren().clear();
if(pathTarget != null){
List> crumbs = constructFlatPath(pathTarget);
for (int i=0; i < crumbs.size(); i++) {
Button crumb = createCrumb(factory, crumbs.get(i));
crumb.setMnemonicParsing(false);
if (i == 0) {
if (! crumb.getStyleClass().contains(STYLE_CLASS_FIRST)) {
crumb.getStyleClass().add(STYLE_CLASS_FIRST);
}
} else {
crumb.getStyleClass().remove(STYLE_CLASS_FIRST);
}
getChildren().add(crumb);
}
}
}
@Override protected void layoutChildren(double x, double y, double w, double h) {
for (int i = 0; i < getChildren().size(); i++) {
Node n = getChildren().get(i);
double nw = snapSize(n.prefWidth(h));
double nh = snapSize(n.prefHeight(-1));
if (i > 0) {
// We have to position the bread crumbs slightly overlapping
double ins = n instanceof BreadCrumbButton ? ((BreadCrumbButton)n).getArrowWidth() : 0;
x = snapPosition(x - ins);
}
n.resize(nw, nh);
n.relocate(x, y);
x += nw;
}
}
/**
* Construct a flat list for the crumbs
* @param bottomMost The crumb node at the end of the path
* @return
*/
private List> constructFlatPath(TreeItem bottomMost){
List> path = new ArrayList<>();
TreeItem current = bottomMost;
do {
path.add(current);
current = current.getParent();
} while (current != null);
Collections.reverse(path);
return path;
}
private Button createCrumb(
final Callback, Button> factory,
final TreeItem selectedCrumb) {
Button crumb = factory.call(selectedCrumb);
crumb.getStyleClass().add("crumb"); //$NON-NLS-1$
// We want all buttons to have the same height
// so we bind their preferred height to the enclosing container
// crumb.prefHeightProperty().bind(getSkinnable().heightProperty());
// listen to the action event of each bread crumb
crumb.setOnAction(ae -> onBreadCrumbAction(selectedCrumb));
return crumb;
}
/**
* Occurs when a bread crumb gets the action event
*
* @param crumbModel The crumb which received the action event
*/
protected void onBreadCrumbAction(final TreeItem crumbModel){
final BreadCrumbBar breadCrumbBar = getSkinnable();
// fire the composite event in the breadCrumbBar
Event.fireEvent(breadCrumbBar, new BreadCrumbActionEvent<>(crumbModel));
// navigate to the clicked crumb
if(breadCrumbBar.isAutoNavigationEnabled()){
breadCrumbBar.setSelectedCrumb(crumbModel);
}
}
/**
* Represents a BreadCrumb Button
*
*
* ----------
* \ \
* / /
* ----------
*
*
*
*/
public static class BreadCrumbButton extends Button {
private final ObjectProperty first = new SimpleObjectProperty<>(this, "first"); //$NON-NLS-1$
private final double arrowWidth = 5;
private final double arrowHeight = 20;
/**
* Create a BreadCrumbButton
*
* @param text Buttons text
*/
public BreadCrumbButton(String text){
this(text, null);
}
/**
* Create a BreadCrumbButton
* @param text Buttons text
* @param gfx Gfx of the Button
*/
public BreadCrumbButton(String text, Node gfx){
super(text, gfx);
first.set(false);
getStyleClass().addListener(new InvalidationListener() {
@Override public void invalidated(Observable arg0) {
updateShape();
}
});
updateShape();
}
private void updateShape(){
this.setShape(createButtonShape());
}
/**
* Gets the crumb arrow with
* @return
*/
public double getArrowWidth(){
return arrowWidth;
}
/**
* Create an arrow path
*
* Based upon Uwe / Andy Till code snippet found here:
* @see http://ustesis.wordpress.com/2013/11/04/implementing-breadcrumbs-in-javafx/
* @return
*/
private Path createButtonShape(){
// build the following shape (or home without left arrow)
// --------
// \ \
// / /
// --------
Path path = new Path();
// begin in the upper left corner
MoveTo e1 = new MoveTo(0, 0);
path.getElements().add(e1);
// draw a horizontal line that defines the width of the shape
HLineTo e2 = new HLineTo();
// bind the width of the shape to the width of the button
e2.xProperty().bind(this.widthProperty().subtract(arrowWidth));
path.getElements().add(e2);
// draw upper part of right arrow
LineTo e3 = new LineTo();
// the x endpoint of this line depends on the x property of line e2
e3.xProperty().bind(e2.xProperty().add(arrowWidth));
e3.setY(arrowHeight / 2.0);
path.getElements().add(e3);
// draw lower part of right arrow
LineTo e4 = new LineTo();
// the x endpoint of this line depends on the x property of line e2
e4.xProperty().bind(e2.xProperty());
e4.setY(arrowHeight);
path.getElements().add(e4);
// draw lower horizontal line
HLineTo e5 = new HLineTo(0);
path.getElements().add(e5);
if(! getStyleClass().contains(STYLE_CLASS_FIRST)){
// draw lower part of left arrow
// we simply can omit it for the first Button
LineTo e6 = new LineTo(arrowWidth, arrowHeight / 2.0);
path.getElements().add(e6);
}else{
// draw an arc for the first bread crumb
ArcTo arcTo = new ArcTo();
arcTo.setSweepFlag(true);
arcTo.setX(0);
arcTo.setY(0);
arcTo.setRadiusX(15.0f);
arcTo.setRadiusY(15.0f);
path.getElements().add(arcTo);
}
// close path
ClosePath e7 = new ClosePath();
path.getElements().add(e7);
// this is a dummy color to fill the shape, it won't be visible
path.setFill(Color.BLACK);
return path;
}
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy