org.openscience.cdk.renderer.generators

Interface IGeneratorParameter<T>

All Known Implementing Classes:

AbstractGeneratorParameter, AtomNumberGenerator.AtomColorer, AtomNumberGenerator.AtomNumberTextColor, AtomNumberGenerator.ColorByType, AtomNumberGenerator.Offset, AtomNumberGenerator.WillDrawAtomNumbers, BasicAtomGenerator.AtomColor, BasicAtomGenerator.AtomColorer, BasicAtomGenerator.AtomRadius, BasicAtomGenerator.ColorByType, BasicAtomGenerator.CompactAtom, BasicAtomGenerator.CompactShape, BasicAtomGenerator.KekuleStructure, BasicAtomGenerator.ShowEndCarbons, BasicAtomGenerator.ShowExplicitHydrogens, BasicBondGenerator.BondDistance, BasicBondGenerator.BondLength, BasicBondGenerator.BondWidth, BasicBondGenerator.DefaultBondColor, BasicBondGenerator.TowardsRingCenterProportion, BasicBondGenerator.WedgeWidth, BasicSceneGenerator.ArrowHeadWidth, BasicSceneGenerator.BackgroundColor, BasicSceneGenerator.FitToScreen, BasicSceneGenerator.FontName, BasicSceneGenerator.ForegroundColor, BasicSceneGenerator.Margin, BasicSceneGenerator.Scale, BasicSceneGenerator.ShowMoleculeTitle, BasicSceneGenerator.ShowTooltip, BasicSceneGenerator.UseAntiAliasing, BasicSceneGenerator.UsedFontStyle, BasicSceneGenerator.ZoomFactor, BoundsGenerator.BoundsColor, ExtendedAtomGenerator.ShowAtomTypeNames, ExtendedAtomGenerator.ShowImplicitHydrogens, MappingGenerator.AtomAtomMappingLineColor, MappingGenerator.MappingLineWidth, MappingGenerator.ShowAtomAtomMapping, ReactionSceneGenerator.ArrowHeadWidth, ReactionSceneGenerator.ShowReactionBoxes, RendererModel.ColorHash, RendererModel.ExternalHighlightColor, RingGenerator.CDKStyleAromaticity, RingGenerator.RingProportion, RingGenerator.ShowAromaticity

public interface IGeneratorParameter<T>

Parameter from some rendering of the 2D diagram. Such parameters may be bond width, (relative) font sizes, coloring scheme, display or not of atomic properties, rendering a circles for aromatic rings, etc.

Method Summary

Methods

Modifier and Type	Method and Description
T	getDefault() Gets the default value for this parameter.
T	getValue() Gets the value for this parameter.
void	setValue(T value) Sets the value for this parameter.

Method Detail

setValue

void setValue(T value)

Sets the value for this parameter.

Parameters:

value - the new parameter value

getValue

T getValue()

Gets the value for this parameter. It must provide a reasonable default when no other value has been set.

Returns:

the current parameter value

getDefault

T getDefault()

Gets the default value for this parameter. This value is set by the parameter class and cannot be changed.

Returns:

the default value for this parameter