org.knime.base.node.viz.aggregation.util
Enum LabelDisplayPolicy

java.lang.Object
  extended by java.lang.Enum<LabelDisplayPolicy>
      extended by org.knime.base.node.viz.aggregation.util.LabelDisplayPolicy
All Implemented Interfaces:
Serializable, Comparable<LabelDisplayPolicy>, ButtonGroupEnumInterface

public enum LabelDisplayPolicy
extends Enum<LabelDisplayPolicy>
implements ButtonGroupEnumInterface

Enumerates all possible label display options and provides some utility functions.

Author:
Tobias Koetter, University of Konstanz

Enum Constant Summary
ALL
          Display the label of all bars..
NONE
          Display none labels at all.
SELECTED
          Display the label of the selected bars.
 
Method Summary
 String getActionCommand()
          Should return the ButtonGroup wide unique action command.
static LabelDisplayPolicy getDefaultOption()
           
static String[] getLabels()
           
static LabelDisplayPolicy getOption4ID(String value)
           
 String getText()
           
 String getToolTip()
          
 boolean isDefault()
          
static LabelDisplayPolicy valueOf(String name)
          Returns the enum constant of this type with the specified name.
static LabelDisplayPolicy[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

NONE

public static final LabelDisplayPolicy NONE
Display none labels at all.


ALL

public static final LabelDisplayPolicy ALL
Display the label of all bars..


SELECTED

public static final LabelDisplayPolicy SELECTED
Display the label of the selected bars.

Method Detail

values

public static LabelDisplayPolicy[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (LabelDisplayPolicy c : LabelDisplayPolicy.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static LabelDisplayPolicy valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
IllegalArgumentException - if this enum type has no constant with the specified name
NullPointerException - if the argument is null

getActionCommand

public String getActionCommand()
Description copied from interface: ButtonGroupEnumInterface
Should return the ButtonGroup wide unique action command. This is typically the return value of the Enum.name() method.

Specified by:
getActionCommand in interface ButtonGroupEnumInterface
Returns:
the id of the label option

getText

public String getText()
Specified by:
getText in interface ButtonGroupEnumInterface
Returns:
the name of the label option

getToolTip

public String getToolTip()

Specified by:
getToolTip in interface ButtonGroupEnumInterface
Returns:
the tool tip of this option could be null

getLabels

public static String[] getLabels()
Returns:
the names of the label options

getDefaultOption

public static LabelDisplayPolicy getDefaultOption()
Returns:
the default aggregation method

getOption4ID

public static LabelDisplayPolicy getOption4ID(String value)
Parameters:
value - the name of the option
Returns:
the option itself

isDefault

public boolean isDefault()

Specified by:
isDefault in interface ButtonGroupEnumInterface
Returns:
true if this is the default option


Copyright, 2003 - 2010. All rights reserved.
University of Konstanz, Germany.
Chair for Bioinformatics and Information Mining, Prof. Dr. Michael R. Berthold.
You may not modify, publish, transmit, transfer or sell, reproduce, create derivative works from, distribute, perform, display, or in any way exploit any of the content, in whole or in part, except as otherwise expressly permitted in writing by the copyright owner or as specified in the license file distributed with this product.