org.smallmind.javafx.extras.choice.EnumChoiceBox Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016 David Berkman
 * 
 * This file is part of the SmallMind Code Project.
 * 
 * The SmallMind Code Project is free software, you can redistribute
 * it and/or modify it under either, at your discretion...
 * 
 * 1) The terms of GNU Affero General Public License as published by the
 * Free Software Foundation, either version 3 of the License, or (at
 * your option) any later version.
 * 
 * ...or...
 * 
 * 2) The terms of the Apache License, Version 2.0.
 * 
 * The SmallMind Code Project 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 or Apache License for more details.
 * 
 * You should have received a copy of the GNU Affero General Public License
 * and the Apache License along with the SmallMind Code Project. If not, see
 *  or .
 * 
 * Additional permission under the GNU Affero GPL version 3 section 7
 * ------------------------------------------------------------------
 * If you modify this Program, or any covered work, by linking or
 * combining it with other code, such other code is not for that reason
 * alone subject to any of the requirements of the GNU Affero GPL
 * version 3.
 */
package org.smallmind.javafx.extras.choice;

import java.util.Arrays;
import java.util.Collections;
import java.util.LinkedList;
import java.util.List;
import javafx.scene.control.ChoiceBox;
import javafx.util.StringConverter;
import org.smallmind.nutsnbolts.util.AlphaNumericComparator;
import org.smallmind.nutsnbolts.util.AlphaNumericConverter;
import org.smallmind.nutsnbolts.util.StringUtility;

public class EnumChoiceBox> extends ChoiceBox {

  private final Class enumClass;

  public EnumChoiceBox (Class enumClass) {

    this(enumClass, null, null);
  }

  public EnumChoiceBox (Class enumClass, E selectedEnum) {

    this(enumClass, selectedEnum, null);
  }

  public EnumChoiceBox (Class enumClass, List exemptEnums) {

    this(enumClass, null, exemptEnums);
  }

  public EnumChoiceBox (Class enumClass, E selectedEnum, List exemptEnums) {

    LinkedList availableEnums = new LinkedList(Arrays.asList(enumClass.getEnumConstants()));

    this.enumClass = enumClass;

    if (exemptEnums != null) {
      for (E exemptEnum : exemptEnums) {
        availableEnums.remove(exemptEnum);
      }
    }

    Collections.sort(availableEnums, new AlphaNumericComparator(new AlphaNumericConverter() {

      @Override
      public String toString (E enumerated) {

        return StringUtility.toDisplayCase(enumerated.name(), '_');
      }
    }));

    setConverter(new StringConverter() {

      @Override
      public String toString (E enumerated) {

        return StringUtility.toDisplayCase(enumerated.name(), '_');
      }

      @Override
      public E fromString (String name) {

        return Enum.valueOf(getEnumClass(), StringUtility.toStaticFieldName(name, '_'));
      }
    });

    getItems().addAll(availableEnums);
    setValue((selectedEnum != null) ? selectedEnum : availableEnums.getFirst());
  }

  public Class getEnumClass () {

    return enumClass;
  }
}