モジュール javafx.controls
パッケージ javafx.scene.control.cell

クラスComboBoxTreeCell<T>

  • 型パラメータ:
    T - TreeViewに含まれているTreeItemの型。
    すべての実装されたインタフェース:
    Styleable, EventTarget, Skinnable

    public class ComboBoxTreeCell<T>
extends TreeCell<T>
    セル内にComboBoxノードを描画するTreeCell実装を含むクラス。

    デフォルトでは、ComboBoxTreeCellは、編集されていない場合はLabelとしてレンダリングされ、編集モードの場合はComboBoxとしてレンダリングされます。 ComboBoxは、デフォルトで、ツリー・セル全体に表示するように拡大されます。

    ComboBoxTreeCellを作成するには、ComboBoxメニューが表示されるとユーザーに表示される0以上のアイテムを提供する必要があります。 これらのアイテムはTreeViewのTreeItemと同じ型である必要があり、これにより、たとえば、選択時にTreeItem.valueProperty()の既存の値を置き換えます。

    導入されたバージョン:
    JavaFX 2.2

    • コンストラクタの詳細

      • ComboBoxTreeCell

        public ComboBoxTreeCell​()
        空のアイテム・リストを持つデフォルトのComboBoxTreeCellを作成します。

      • ComboBoxTreeCell

        @SafeVarargs
public ComboBoxTreeCell​(T... items)
        ComboBoxが表示されているときにComboBoxの移入に使用される、指定されたアイテムを含むデフォルトのComboBoxTreeCellインスタンスを作成します。
        パラメータ:
        items - ユーザーが選択した場合に、ComboBoxポップアップ・メニューに表示されるアイテム。

      • ComboBoxTreeCell

        @SafeVarargs
public ComboBoxTreeCell​(StringConverter<T> converter,
                        T... items)
        ComboBoxが表示されるときに、その値の移入に使用される、指定されたアイテムを含むComboBoxTreeCellインスタンス、およびアイテムをユーザーが読取り可能な形式に変換するために使用されるStringConverterを作成します。
        パラメータ:
        converter - 型Tのアイテムをユーザーが読取り可能な文字列に変換して、ComboBoxポップアップ・メニューに表示できるようにするStringConverter。
        items - ユーザーが選択した場合に、ComboBoxポップアップ・メニューに表示されるアイテム。

      • ComboBoxTreeCell

        public ComboBoxTreeCell​(ObservableList<T> items)
        ComboBoxが表示されているときにComboBoxの移入に使用される、指定されたアイテムを含むデフォルトのComboBoxTreeCellインスタンスを作成します。
        パラメータ:
        items - ユーザーが選択した場合に、ComboBoxポップアップ・メニューに表示されるアイテム。

      • ComboBoxTreeCell

        public ComboBoxTreeCell​(StringConverter<T> converter,
                        ObservableList<T> items)
        ComboBoxが表示されるときに、その値の移入に使用される、指定されたアイテムを含むComboBoxTreeCellインスタンス、およびアイテムをユーザーが読取り可能な形式に変換するために使用されるStringConverterを作成します。
        パラメータ:
        converter - 型Tのアイテムをユーザーが読取り可能な文字列に変換して、ComboBoxポップアップ・メニューに表示できるようにするStringConverter。
        items - ユーザーが選択した場合に、ComboBoxポップアップ・メニューに表示されるアイテム。

    • メソッドの詳細

      • forTreeView

        @SafeVarargs
public static <T> Callback<TreeView<T>,TreeCell<T>> forTreeView​(T... items)
        TreeViewコントロールで使用するComboBoxセル・ファクトリを作成します。 デフォルトでは、ComboBoxCellは、編集されていない場合はLabelとしてレンダリングされ、編集モードの場合はComboBoxとしてレンダリングされます。 ComboBoxは、デフォルトで、ツリー・セル全体に表示するように拡大されます。
        型パラメータ:
        T - TreeViewに含まれる要素の型。
        パラメータ:
        items - ComboBoxメニューが表示されるとユーザーに表示される0以上のアイテム。 これらのアイテムは、選択時にTreeItem valueプロパティの既存の値を置き換えるように、TreeView<T>と同じ型でなければなりません。
        戻り値:
        TreeViewに含まれる要素の型で動作できるTreeCellを返すCallback。

      • forTreeView

        public static <T> Callback<TreeView<T>,TreeCell<T>> forTreeView​(ObservableList<T> items)
        TreeViewコントロールで使用するComboBoxセル・ファクトリを作成します。 デフォルトでは、ComboBoxCellは、編集されていない場合はLabelとしてレンダリングされ、編集モードの場合はComboBoxとしてレンダリングされます。 ComboBoxは、デフォルトで、ツリー・セルのインデント、および公開ノード(つまり、矢印)に割り当てられているスペースを除き、ツリー・セル全体に表示するように拡大されます。
        型パラメータ:
        T - TreeViewに含まれるTreeItem要素の型。
        パラメータ:
        items - ComboBoxメニューが表示されるとユーザーに表示される0以上のアイテムを含むObservableList。 これらのアイテムは、TreeView汎用型と同じ型である必要があり、これにより、たとえば、選択時に(TreeView.editingItemProperty()で述べているように)編集されるTreeItemの既存値を置き換えます。
        戻り値:
        TreeViewに含まれる要素の型で動作できるTreeCellを返すCallback。

      • forTreeView

        @SafeVarargs
public static <T> Callback<TreeView<T>,TreeCell<T>> forTreeView​(StringConverter<T> converter,
                                                                T... items)
        TreeViewコントロールで使用するComboBoxセル・ファクトリを作成します。 デフォルトでは、ComboBoxCellは、編集されていない場合はLabelとしてレンダリングされ、編集モードの場合はComboBoxとしてレンダリングされます。 ComboBoxは、デフォルトで、ツリー・セル全体に表示するように拡大されます。
        型パラメータ:
        T - TreeViewに含まれる要素の型。
        パラメータ:
        converter - (型Tの)指定されたアイテムをユーザーに表示するために文字列に変換するStringConverter。
        items - ComboBoxメニューが表示されるとユーザーに表示される0以上のアイテム。 これらのアイテムは、選択時にTreeItem valueプロパティの既存の値を置き換えるように、TreeView<T>と同じ型でなければなりません。
        戻り値:
        TreeViewに含まれる要素の型で動作できるTreeCellを返すCallback。

      • forTreeView

        public static <T> Callback<TreeView<T>,TreeCell<T>> forTreeView​(StringConverter<T> converter,
                                                                ObservableList<T> items)
        TreeViewコントロールで使用するComboBoxセル・ファクトリを作成します。 デフォルトでは、ComboBoxCellは、編集されていない場合はLabelとしてレンダリングされ、編集モードの場合はComboBoxとしてレンダリングされます。 ComboBoxは、デフォルトで、ツリー・セル全体に表示するように拡大されます。
        型パラメータ:
        T - TreeViewに含まれる要素の型。
        パラメータ:
        converter - (型Tの)指定されたアイテムをユーザーに表示するために文字列に変換するStringConverter。
        items - ComboBoxメニューが表示されるとユーザーに表示される0以上のアイテムを含むObservableList。 これらのアイテムは、TreeView汎用型と同じ型である必要があり、これにより、たとえば、選択時に(TreeView.editingItemProperty()で述べているように)編集されるTreeItemの既存値を置き換えます。
        戻り値:
        TreeViewに含まれる要素の型で動作できるTreeCellを返すCallback。

      • setComboBoxEditable

        public final void setComboBoxEditable​(boolean value)
        ComboBoxを編集可能に構成します(オプション以外のユーザー入力をドロップダウン・リストに提供することを許可します)。
        パラメータ:
        value - このComboBoxに設定される編集可能な値

      • isComboBoxEditable

        public final boolean isComboBoxEditable​()
        ComboBoxが編集可能な場合はtrueを返します。
        戻り値:
        ComboBoxが編集可能な場合はtrue

      • getItems

        public ObservableList<T> getItems​()
        ComboBoxが表示されているときに表示されるアイテムを返します。
        戻り値:
        このComboBoxが表示されているときに表示されるアイテム

      • startEdit

        public void startEdit​()
        この関数を呼び出して、セルが編集可能な場合に、非編集状態から編集状態に遷移します。 セルがすでに編集状態である場合は、その状態のままになります。
        オーバーライド:
        startEdit 、クラス: TreeCell<T>

      • cancelEdit

        public void cancelEdit​()
        この関数を呼び出して、ユーザーによる入力を保存せずに、編集状態から非編集状態に遷移します。
        オーバーライド:
        cancelEdit 、クラス: TreeCell<T>

      • updateItem

        public void updateItem​(T item,
                       boolean empty)
        updateItemメソッドは、開発者にとって、呼び出すことはできないが、オーバーライドしてセルのビジュアルをカスタマイズできる、最適なメソッドです。 つまり、開発者は、コードでこのメソッドを呼び出さないようにしてください。このメソッドは、ListViewコントロールなどのUIコントロールによってのみ呼び出されるようにする必要があります。 ただし、updateItemメソッドが存在する理由は、開発者がカスタム・セル・ファクトリ(ListView cell factoryなど)を指定するときに、updateItemメソッドをオーバーライドして、セルを完全にカスタマイズできるようにすることです。

        CellのサブクラスがupdateItemメソッドを適切にオーバーライドすることは非常に重要であり、これは、そのようにしないと、セルが空白になったり、セルに予期しないコンテンツが含まれるなどの問題が発生するためです。 updateItemメソッドを適切にオーバーライドする方法の例を次に示します。 

         protected void updateItem(T item, boolean empty) {
     super.updateItem(item, empty);

     if (empty || item == null) {
         setText(null);
         setGraphic(null);
     } else {
         setText(item.toString());
     }
 }

        このコード・サンプルには次の2つの重要なポイントがあることに注意してください。

        1. super.updateItem(T, boolean)メソッドを呼び出します。 これを行わないと、itemプロパティとemptyプロパティが正しく設定されず、グラフィカルな問題が発生する可能性があります。
        2. empty状態をテストし、trueの場合は、textプロパティとgraphicプロパティをnullに設定します。 これを行わないと、ほぼ確実に、エンド・ユーザーに対して予想外のグラフィカル・アーティファクトがセル内に表示されます。
        パラメータ:
        item - セルの新しいアイテム。
        empty - このセルがリストからのデータを表しているかどうか。 空の場合、いずれのドメイン・データも表しませんが、空の行のレンダリングに使用されるセルとなります。