org.openscience.cdk.renderer.generators

Class RingGenerator

java.lang.Object

org.openscience.cdk.renderer.generators.BasicBondGenerator

org.openscience.cdk.renderer.generators.RingGenerator

All Implemented Interfaces:

IGenerator<IAtomContainer>

@TestClass(value="org.openscience.cdk.renderer.generators.RingGeneratorTest")
public class RingGenerator
extends BasicBondGenerator

Generates just the aromatic indicators for rings : circles, or light-gray inner bonds, depending on the value of CDKStyleAromaticity.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RingGenerator.CDKStyleAromaticity Depicts aromaticity of rings in the original CDK style.
static class	RingGenerator.RingProportion The proportion of a ring bounds to use to draw the ring.
static class	RingGenerator.ShowAromaticity Determines whether rings should be drawn with a circle if they are aromatic.

Nested classes/interfaces inherited from class org.openscience.cdk.renderer.generators.BasicBondGenerator

BasicBondGenerator.BondDistance, BasicBondGenerator.BondLength, BasicBondGenerator.BondWidth, BasicBondGenerator.DefaultBondColor, BasicBondGenerator.TowardsRingCenterProportion, BasicBondGenerator.WedgeWidth

Constructor Summary

Constructors

Constructor and Description
RingGenerator() Make a generator for ring elements.

Method Summary

Methods

Modifier and Type	Method and Description
IRenderingElement	generateRingElements(IBond bond, IRing ring, RendererModel model) Generate ring elements, such as inner-ring bonds or ring stereo elements.
List<IGeneratorParameter<?>>	getParameters() Returns the list of IGeneratorParameter for this particular generator.

Methods inherited from class org.openscience.cdk.renderer.generators.BasicBondGenerator

generate, generate, generateBond, generateBondElement, generateBondElement, generateInnerElement, getColorForBond, getWidthForBond, setOverrideBondWidth, setOverrideColor

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RingGenerator

public RingGenerator()

Make a generator for ring elements.

Method Detail

generateRingElements

public IRenderingElement generateRingElements(IBond bond,
                                     IRing ring,
                                     RendererModel model)

Generate ring elements, such as inner-ring bonds or ring stereo elements.

Overrides:

generateRingElements in class BasicBondGenerator

Parameters:

bond - the ring bond to use when generating elements

ring - the ring that the bond is in

model - the renderer model

Returns:

one or more rendering elements

getParameters

@TestMethod(value="testGetParameters")
public List<IGeneratorParameter<?>> getParameters()

Returns the list of IGeneratorParameter for this particular generator.

Specified by:

getParameters in interface IGenerator<IAtomContainer>

Overrides:

getParameters in class BasicBondGenerator

Returns:

a List of IGeneratorParameters