de.labAlive.core.parameters.parameter

Enum ParameterDetailLevel

java.lang.Object

java.lang.Enum<ParameterDetailLevel>

de.labAlive.core.parameters.parameter.ParameterDetailLevel

All Implemented Interfaces:

ParameterDetailLevelProvider, java.io.Serializable, java.lang.Comparable<ParameterDetailLevel>

public enum ParameterDetailLevel
extends java.lang.Enum<ParameterDetailLevel>
implements ParameterDetailLevelProvider

A Parameter has a ParameterDetailLevel. The PropertyWindow has a ParameterDetailLevel (default GENERAL, can be increment by the user to higher levels of detail) that controls if a Parameter is visible.

Version:

2.0

Author:

riederer

Enum Constant Summary

Enum Constants

Enum Constant and Description
DETAIL_LEVEL1
DETAIL_LEVEL2
DETAIL_LEVEL3
GENERAL
HIDDEN
READ_ONLY

Method Summary

Modifier and Type	Method and Description
ParameterDetailLevel	getDetailLevel()
boolean	hasMoreDetails()
ParameterDetailLevel	incrementDetailLevel()
boolean	isReadOnly()
boolean	isReadOnlyAndVisible(ParameterDetailLevel propertyWindowDetailLevel)
boolean	isVisible(ParameterDetailLevel propertyWindowDetailLevel) Checks if a Parameter with this parameterDetailLevel should be visible.
static ParameterDetailLevel	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ParameterDetailLevel[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

HIDDEN

public static final ParameterDetailLevel HIDDEN

GENERAL

public static final ParameterDetailLevel GENERAL

DETAIL_LEVEL1

public static final ParameterDetailLevel DETAIL_LEVEL1

DETAIL_LEVEL2

public static final ParameterDetailLevel DETAIL_LEVEL2

DETAIL_LEVEL3

public static final ParameterDetailLevel DETAIL_LEVEL3

READ_ONLY

public static final ParameterDetailLevel READ_ONLY

Method Detail

values

public static ParameterDetailLevel[] 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 (ParameterDetailLevel c : ParameterDetailLevel.values())
    System.out.println(c);

Returns:

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

valueOf

public static ParameterDetailLevel valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

incrementDetailLevel

public ParameterDetailLevel incrementDetailLevel()

hasMoreDetails

public boolean hasMoreDetails()

isReadOnly

public boolean isReadOnly()

getDetailLevel

public ParameterDetailLevel getDetailLevel()

Specified by:

getDetailLevel in interface ParameterDetailLevelProvider

isVisible

public boolean isVisible(ParameterDetailLevel propertyWindowDetailLevel)

Checks if a Parameter with this parameterDetailLevel should be visible.

Parameters:

propertyWindowDetailLevel -

Returns:

isReadOnlyAndVisible

public boolean isReadOnlyAndVisible(ParameterDetailLevel propertyWindowDetailLevel)