AtomNumberGenerator (cdk 2.10 API)

java.lang.Object
- org.openscience.cdk.renderer.generators.AtomNumberGenerator

All Implemented Interfaces:

IGenerator<IAtomContainer>
```
public class AtomNumberGenerator
extends Object
implements IGenerator<IAtomContainer>
```
IGenerator for IAtomContainers that will draw atom numbers for the atoms.

Author:

maclean

Source code:
main

Belongs to CDK module:
renderextra

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`AtomNumberGenerator.AtomColorer`	The color scheme by which to color the atom numbers, if the `AtomNumberGenerator.ColorByType` boolean is true.
`static class`	`AtomNumberGenerator.AtomNumberTextColor`	Color to draw the atom numbers with.
`static class`	`AtomNumberGenerator.ColorByType`	Boolean to indicate of the `AtomNumberGenerator.AtomColorer` scheme will be used.
`static class`	`AtomNumberGenerator.Offset`	Offset vector in screen space coordinates where the atom number label will be placed.
`static class`	`AtomNumberGenerator.WillDrawAtomNumbers`	Boolean parameter indicating if atom numbers should be drawn, allowing this feature to be disabled temporarily.

Constructor Summary

Constructors
Constructor Description

AtomNumberGenerator()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`IRenderingElement`	`generate(IAtomContainer container, RendererModel model)`	Converts a `IChemObject` from the chemical data model into something that can be drawn in the chemical drawing.
`List<IGeneratorParameter<?>>`	`getParameters()`	Returns the list of `IGeneratorParameter` for this particular generator.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AtomNumberGenerator
```
public AtomNumberGenerator()
```
- Method Detail
  - generate
```
public IRenderingElement generate(IAtomContainer container,
                                  RendererModel model)
```
    Converts a IChemObject from the chemical data model into something that can be drawn in the chemical drawing.
    
    Specified by:
    
    generate in interface IGenerator<IAtomContainer>
    
    Parameters:
    
    container - the chemical entity to be depicted
    
    model - the rendering parameters
    
    Returns:
    
    a drawable chemical depiction component
  - getParameters
```
public List<IGeneratorParameter<?>> getParameters()
```
    Returns the list of IGeneratorParameter for this particular generator.
    
    Specified by:
    
    getParameters in interface IGenerator<IAtomContainer>
    
    Returns:
    
    a List of IGeneratorParameters