javafx.scene.control.TreeTablePosition Maven / Gradle / Ivy
/*
* Copyright (c) 2011, 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 javafx.scene.control;
import java.lang.ref.WeakReference;
/**
* This class is used to represent a single row/column/cell in a TreeTableView.
* This is used throughout the TreeTableView API to represent which rows/columns/cells
* are currently selected, focused, being edited, etc. Note that this class is
* immutable once it is created.
*
* Because the TreeTableView can have different
* {@link SelectionMode selection modes}, the row and column properties in
* TablePosition can be 'disabled' to represent an entire row or column. This is
* done by setting the unrequired property to -1 or null.
*
* @param The type of the {@link TreeItem} instances contained within the
* TreeTableView.
* @param The type of the items contained within the TreeTableColumn.
* @see TreeTableView
* @see TreeTableColumn
* @since JavaFX 8.0
*/
public class TreeTablePosition extends TablePositionBase> {
/***************************************************************************
* *
* Constructors *
* *
**************************************************************************/
/**
* Constructs a TreeTablePosition instance to represent the given row/column
* position in the given TreeTableView instance. Both the TreeTableView and
* TreeTableColumn are referenced weakly in this class, so it is possible that
* they will be null when their respective getters are called.
*
* @param treeTableView The TreeTableView that this position is related to.
* @param row The row that this TreeTablePosition is representing.
* @param tableColumn The TreeTableColumn instance that this TreeTablePosition represents.
*/
public TreeTablePosition(TreeTableView treeTableView, int row, TreeTableColumn tableColumn) {
super(row, tableColumn);
this.controlRef = new WeakReference>(treeTableView);
}
/***************************************************************************
* *
* Instance Variables *
* *
**************************************************************************/
private final WeakReference> controlRef;
/***************************************************************************
* *
* Public API *
* *
**************************************************************************/
/**
* The column index that this TreeTablePosition represents in the TreeTableView. It
* is -1 if the TreeTableView or TreeTableColumn instances are null.
*/
@Override public int getColumn() {
TreeTableView tableView = getTreeTableView();
TreeTableColumn tableColumn = getTableColumn();
return tableView == null || tableColumn == null ? -1 :
tableView.getVisibleLeafIndex(tableColumn);
}
/**
* The TreeTableView that this TreeTablePosition is related to.
*/
public final TreeTableView getTreeTableView() {
return controlRef.get();
}
@Override public final TreeTableColumn getTableColumn() {
// Forcing the return type to be TreeTableColumn, not TableColumnBase
return super.getTableColumn();
}
}