org.openscience.cdk.renderer.generators.standard

Enum StandardGenerator.HighlightStyle

java.lang.Object

java.lang.Enum<StandardGenerator.HighlightStyle>

org.openscience.cdk.renderer.generators.standard.StandardGenerator.HighlightStyle

All Implemented Interfaces:

Serializable, Comparable<StandardGenerator.HighlightStyle>

Enclosing class:

StandardGenerator

public static enum StandardGenerator.HighlightStyle
extends Enum<StandardGenerator.HighlightStyle>

Enumeration of highlight style.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Colored Displayed atom symbols and bonds are coloured.
None Ignore highlight hints.
OuterGlow An outer glow is placed in the background behind the depiction.
OuterGlowWhiteEdge Same as outer glow but puts a white edge around element symbols.

Method Summary

Modifier and Type	Method and Description
static StandardGenerator.HighlightStyle	valueOf(String name) Returns the enum constant of this type with the specified name.
static StandardGenerator.HighlightStyle[]	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 StandardGenerator.HighlightStyle None

Ignore highlight hints.

Colored

public static final StandardGenerator.HighlightStyle Colored

Displayed atom symbols and bonds are coloured.

OuterGlow

public static final StandardGenerator.HighlightStyle OuterGlow

An outer glow is placed in the background behind the depiction.

See Also:

StandardGenerator.OuterGlowWidth

OuterGlowWhiteEdge

public static final StandardGenerator.HighlightStyle OuterGlowWhiteEdge

Same as outer glow but puts a white edge around element symbols. This is useful if color atoms are used in combination with an outer glow highlight.

See Also:

StandardGenerator.OuterGlowWidth

Method Detail

values

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

Returns:

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

valueOf

public static StandardGenerator.HighlightStyle 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