javafx.scene.control.ControlUtils Maven / Gradle / Ivy
/*
* Copyright (c) 2013, 2022, 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 javafx.scene.control;
import com.sun.javafx.scene.control.skin.Utils;
import javafx.collections.ListChangeListener;
import javafx.collections.ObservableList;
import javafx.event.Event;
import javafx.scene.Node;
import javafx.scene.Parent;
import javafx.scene.Scene;
import java.util.Collections;
import java.util.Comparator;
import java.util.List;
import java.util.function.IntPredicate;
import java.util.stream.Collectors;
class ControlUtils {
private ControlUtils() { }
public static void scrollToIndex(final Control control, int index) {
Utils.executeOnceWhenPropertyIsNonNull(control.skinProperty(), (Skin skin) -> {
Event.fireEvent(control, new ScrollToEvent<>(control, control, ScrollToEvent.scrollToTopIndex(), index));
});
}
public static void scrollToColumn(final Control control, final TableColumnBase column) {
Utils.executeOnceWhenPropertyIsNonNull(control.skinProperty(), (Skin skin) -> {
control.fireEvent(new ScrollToEvent>(control, control, ScrollToEvent.scrollToColumn(), column));
});
}
static void requestFocusOnControlOnlyIfCurrentFocusOwnerIsChild(Control c) {
Scene scene = c.getScene();
final Node focusOwner = scene == null ? null : scene.getFocusOwner();
if (focusOwner == null) {
c.requestFocus();
} else if (! c.equals(focusOwner)) {
Parent p = focusOwner.getParent();
while (p != null) {
if (c.equals(p)) {
c.requestFocus();
break;
}
p = p.getParent();
}
}
}
static ListChangeListener.Change buildClearAndSelectChange(
ObservableList list, List removed, T retainedRow, Comparator rowComparator) {
return new ListChangeListener.Change(list) {
private final int[] EMPTY_PERM = new int[0];
private final int removedSize = removed.size();
private final List firstRemovedRange;
private final List secondRemovedRange;
private boolean invalid = true;
private boolean atFirstRange = true;
private int from = -1;
{
int insertionPoint = Collections.binarySearch(removed, retainedRow, rowComparator);
if (insertionPoint >= 0) {
firstRemovedRange = removed;
secondRemovedRange = Collections.emptyList();
} else {
int midIndex = -insertionPoint - 1;
firstRemovedRange = removed.subList(0, midIndex);
secondRemovedRange = removed.subList(midIndex, removedSize);
}
}
@Override public int getFrom() {
checkState();
return from;
}
@Override public int getTo() {
return getFrom();
}
@Override public List getRemoved() {
checkState();
return atFirstRange ? firstRemovedRange : secondRemovedRange;
}
@Override public int getRemovedSize() {
checkState();
return atFirstRange ? firstRemovedRange.size() : secondRemovedRange.size();
}
@Override protected int[] getPermutation() {
checkState();
return EMPTY_PERM;
}
@Override public boolean next() {
if (invalid) {
invalid = false;
// point 'from' to the first position, relative to
// the underlying selectedCells index.
from = atFirstRange ? 0 : 1;
return true;
}
if (atFirstRange && !secondRemovedRange.isEmpty()) {
atFirstRange = false;
// point 'from' to the second position, relative to
// the underlying selectedCells index.
from = 1;
return true;
}
return false;
}
@Override public void reset() {
invalid = true;
atFirstRange = !firstRemovedRange.isEmpty();
}
private void checkState() {
if (invalid) {
throw new IllegalStateException("Invalid Change state: next() must be called before inspecting the Change.");
}
}
};
}
public static void updateSelectedIndices(MultipleSelectionModelBase sm, boolean isCellSelectionEnabled, ListChangeListener.Change> c, IntPredicate removeRowFilter) {
sm.selectedIndices._beginChange();
while (c.next()) {
// it may look like all we are doing here is collecting the removed elements (and
// counting the added elements), but the call to 'peek' is also crucial - it is
// ensuring that the selectedIndices bitset is correctly updated.
sm.startAtomic();
final List removed = c.getRemoved().stream()
.mapToInt(TablePositionBase::getRow)
.distinct()
.filter(removeRowFilter)
.boxed()
.peek(sm.selectedIndices::clear)
.collect(Collectors.toList());
final int addedSize = (int)c.getAddedSubList().stream()
.mapToInt(TablePositionBase::getRow)
.distinct()
.peek(sm.selectedIndices::set)
.count();
sm.stopAtomic();
int from = c.getFrom();
if (isCellSelectionEnabled && 0 < from && from < c.getList().size()) {
// convert origin of change of list of tablePositions
// into origin of change of list of rows
int tpRow = c.getList().get(from).getRow();
from = sm.selectedIndices.indexOf(tpRow);
}
final int to = from + addedSize;
if (c.wasReplaced()) {
sm.selectedIndices._nextReplace(from, to, removed);
} else if (c.wasRemoved()) {
sm.selectedIndices._nextRemove(from, removed);
} else if (c.wasAdded()) {
sm.selectedIndices._nextAdd(from, to);
}
}
c.reset();
sm.selectedIndices.reset();
if (sm.isAtomic()) {
return;
}
// Fix for RT-31577 - the selectedItems list was going to
// empty, but the selectedItem property was staying non-null.
// There is a unit test for this, so if a more elegant solution
// can be found in the future and this code removed, the unit
// test will fail if it isn't fixed elsewhere.
// makeAtomic toggle added to resolve RT-32618
if (sm.getSelectedItems().isEmpty() && sm.getSelectedItem() != null) {
sm.setSelectedItem(null);
}
sm.selectedIndices._endChange();
}
public static int getIndexOfChildWithDescendant(TreeItem parent, TreeItem item) {
if (item == null || parent == null) {
return -1;
}
TreeItem child = item, ancestor = item.getParent();
while (ancestor != null) {
if (ancestor == parent) {
return parent.getChildren().indexOf(child);
}
child = ancestor;
ancestor = child.getParent();
}
return -1;
}
public static boolean isTreeItemIncludingAncestorsExpanded(TreeItem item) {
if (item == null || !item.isExpanded()) {
return false;
}
TreeItem ancestor = item.getParent();
while (ancestor != null) {
if (!ancestor.isExpanded()) {
return false;
}
ancestor = ancestor.getParent();
}
return true;
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy