chemaxon.marvin.io.image

Class ImageExporter.Builder<T extends ImageExporter.Builder<T>>

java.lang.Object

chemaxon.formats.GeneralExportOptions.Builder<T>

chemaxon.marvin.io.image.ImageExporter.Builder<T>

Direct Known Subclasses:

EmfExporter.Builder, JpegExporter.Builder, MsbmpExporter.Builder, PdfExporter.Builder, PngExporter.Builder, SvgExporter.Builder

Enclosing class:

ImageExporter

public abstract static class ImageExporter.Builder<T extends ImageExporter.Builder<T>>
extends chemaxon.formats.GeneralExportOptions.Builder<T>

Property Summary

Type	Property and Description
T	showValence Show valence property on atoms that have the valence property explicitly set.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
T	anyBondStyle(ImageExporter.LineType type) Sets the drawing style for ANY bonds.
T	atomAndBondColors(java.lang.String colors) Set the atom and bond colors.
T	atomFont(java.lang.String fontType) Atom font type.
T	atomLabelSize(double d) Sets the atom label font size.
T	atomMapping() Displays atom mapping.
T	atomNumber() Displays atom numbers.
T	atomNumberType(ImageExporter.AtomNumberingType type) Sets the type of atom numbering: Atom numbers or IUPAC numbering.
T	ballRadius(double d) Sets the ball radius in ball and stick mode.
T	bgColor(java.lang.String rgb) Sets the background color.
T	bgColorAlpha(java.lang.String argb) Sets the background color with alpha value.
T	bondHashSpacing(double spacing) The spacing of the hash in hashed bonds in C-C bond length units.
T	bondWidth(double d) Sets the width of the double bond.
abstract ImageExporter	build() Builds an unmodifiable export option.
T	carbonDisplay(ImageExporter.CarbonDisplay display) Show the atom labels on carbon atoms.
T	chargeFont(java.lang.String fontType) Font type in circled charge display.
T	chiralityDisplay(ImageExporter.ChiralityDisplayOption option) Sets the chirality display option.
T	coloring(ImageExporter.Coloring c) Sets the coloring scheme.
T	coordBondStyle(ImageExporter.LineType lineType) Coordinate bond display style.
T	coordBondStyleAtMulticenter(ImageExporter.LineType lineType) Coordinate bond display style when it connects to a multicenter atom.
T	displayChargeInCircle() Display charge symbols in a circle.
T	explicitLonePairs() Display the explicit lone pairs instead of the implicit lone pairs if lone pair displaying is switched on.
T	height(int h) Sets the height of the image.
T	hideAtomSymbols() Hide atom symbol in 3D mode.
T	hideRGroups() R-groups won't be displayed.
T	hydrogenDisplay(ImageExporter.HydrogenDisplayOption option) Sets the hydrogen display option.
T	ligandOrderVisibility(ImageExporter.LigandOrderVisibility visibility) Displays ligand orders.
T	lonePairs() Display lone pairs.
T	lonePairsAsLine() Display lone pairs as a line instead of the default two dots.
T	marginSize(double size) Size of the margin in pt.
T	maxScale(double d) Sets the maximum magnification to prevent overscaling.
T	noAntiAlias() Switch off antialiasing.
T	oneLetterPeptide() Display peptides with their one letter abbreviation instead of the three letter abbreviation which is the default.
T	rendering(ImageExporter.Rendering r) Sets the rendering style.
T	scale(double d) Sets the magnification.
protected abstract T	self()
T	showAbsoluteLabel() Sets the Abolute label to visibile.
T	showAtomProperties() Show atom properties.
T	showBondLength() Displays the length of bonds in Angstroms.
T	showEZ() Show E/Z.
T	showGraphInvariants() Displays graph invariants.
T	showLigandError() Show ligand errors on R-groups.
T	showValenceError() Displays valence errors.
T	showValenceProperty() Show valence property on atoms that have the valence property explicitly set.
T	stickThickness(double d) Sets the stick diameter in ball and stick mode.
T	transparentBg() Sets the image background to transparent.
T	useSetColors() Use atom/bond set colors.
T	wedgeOrientationUp() Sets down wedge orientation to upward (default downward).
T	width(int w) Sets the width of the image.
T	wireThickness(double d) Sets the bond thickness in wireframe mode.

Methods inherited from class chemaxon.formats.GeneralExportOptions.Builder

aromatization, hydrogenize

Methods inherited from class java.lang.Object

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

Property Detail

showValence

public T extends ImageExporter.Builder<T> showValenceProperty

Show valence property on atoms that have the valence property explicitly set.

Constructor Detail

Builder

public Builder()

Method Detail

self

protected abstract T self()

Specified by:

self in class chemaxon.formats.GeneralExportOptions.Builder<T extends ImageExporter.Builder<T>>

build

public abstract ImageExporter build()

Builds an unmodifiable export option.

Specified by:

build in class chemaxon.formats.GeneralExportOptions.Builder<T extends ImageExporter.Builder<T>>

Returns:

the options

hydrogenDisplay

public T hydrogenDisplay(ImageExporter.HydrogenDisplayOption option)

Sets the hydrogen display option.

Parameters:

option - the display option

Returns:

the builder itself

chiralityDisplay

public T chiralityDisplay(ImageExporter.ChiralityDisplayOption option)

Sets the chirality display option.

Parameters:

option - the display option

Returns:

the builder itself

width

public T width(int w)

Sets the width of the image.

Parameters:

w - the width in pixels

Returns:

the builder itself

height

public T height(int h)

Sets the height of the image.

Parameters:

h - the height in pixels

Returns:

the builder itself

scale

public T scale(double d)

Sets the magnification.

Parameters:

d - the magnification

Returns:

the builder itself

maxScale

public T maxScale(double d)

Sets the maximum magnification to prevent overscaling.

Parameters:

d - the maximum value for magnification

Returns:

the builder itself

atomLabelSize

public T atomLabelSize(double d)

Sets the atom label font size.

Parameters:

d - the size value

Returns:

the builder itself

bondWidth

public T bondWidth(double d)

Sets the width of the double bond.

Parameters:

d - the width

Returns:

the builder itself

wireThickness

public T wireThickness(double d)

Sets the bond thickness in wireframe mode.

Parameters:

d - the thickness value

Returns:

the builder itself

stickThickness

public T stickThickness(double d)

Sets the stick diameter in ball and stick mode.

Parameters:

d - the diameter value

Returns:

the builder itself

ballRadius

public T ballRadius(double d)

Sets the ball radius in ball and stick mode.

Parameters:

d - the ball radius value

Returns:

the builder itself

bgColor

public T bgColor(java.lang.String rgb)

Sets the background color.

Parameters:

rgb - the background color in RGB

Returns:

the builder itself

bgColorAlpha

public T bgColorAlpha(java.lang.String argb)

Sets the background color with alpha value.

Parameters:

argb - the alpha value + the RGB code

Returns:

the builder itself

transparentBg

public T transparentBg()

Sets the image background to transparent.

Returns:

the builder itself

coloring

public T coloring(ImageExporter.Coloring c)

Sets the coloring scheme.

Parameters:

c - the coloring scheme

Returns:

the builder itself

useSetColors

public T useSetColors()

Use atom/bond set colors.

Returns:

the builder itself

atomAndBondColors

public T atomAndBondColors(java.lang.String colors)

Set the atom and bond colors.

Parameters:

colors - the colors string. Use "ak:#rrggbb" for atom set k, "bk:#rrggbb" for bond set k.

Returns:

the builder itself

See Also:

http://www.chemaxon.com/marvin/help/formats/images-doc.html

rendering

public T rendering(ImageExporter.Rendering r)

Sets the rendering style.

Parameters:

r - rendering style

Returns:

the builder itself

noAntiAlias

public T noAntiAlias()

Switch off antialiasing.

Returns:

the builder itself

atomMapping

public T atomMapping()

Displays atom mapping.

Returns:

the builder itself

atomNumber

public T atomNumber()

Displays atom numbers.

Returns:

the builder itself

atomNumberType

public T atomNumberType(ImageExporter.AtomNumberingType type)

Sets the type of atom numbering: Atom numbers or IUPAC numbering.

Parameters:

type - atom numbers or IUPAC numbering

Returns:

the builder itself

lonePairs

public T lonePairs()

Display lone pairs.

Returns:

the builder itself

explicitLonePairs

public T explicitLonePairs()

Display the explicit lone pairs instead of the implicit lone pairs if lone pair displaying is switched on.

Returns:

the builder itself

lonePairsAsLine

public T lonePairsAsLine()

Display lone pairs as a line instead of the default two dots. This parameter has effect only if the lonePair parameter is also specified.

Returns:

the builder itself

wedgeOrientationUp

public T wedgeOrientationUp()

Sets down wedge orientation to upward (default downward).

Returns:

the builder itself

anyBondStyle

public T anyBondStyle(ImageExporter.LineType type)

Sets the drawing style for ANY bonds. LineType.ARROW is not accepted.

Parameters:

type - the line type

Returns:

the builder itself

hideAtomSymbols

public T hideAtomSymbols()

Hide atom symbol in 3D mode.

Returns:

the builder itself

showValenceProperty

public T showValenceProperty()

Show valence property on atoms that have the valence property explicitly set.

showEZ

public T showEZ()

Show E/Z.

Returns:

the builder itself

carbonDisplay

public T carbonDisplay(ImageExporter.CarbonDisplay display)

Show the atom labels on carbon atoms.

Parameters:

display - the carbon atom display option

Returns:

the builder itself

showGraphInvariants

public T showGraphInvariants()

Displays graph invariants.

Returns:

the builder itself

showBondLength

public T showBondLength()

Displays the length of bonds in Angstroms.

Returns:

the builder itself

showValenceError

public T showValenceError()

Displays valence errors.

Returns:

the builder itself

showAbsoluteLabel

public T showAbsoluteLabel()

Sets the Abolute label to visibile.

Returns:

the builder itself

ligandOrderVisibility

public T ligandOrderVisibility(ImageExporter.LigandOrderVisibility visibility)

Displays ligand orders.

Parameters:

visibility - the ligand order display value

Returns:

the builder itself

showLigandError

public T showLigandError()

Show ligand errors on R-groups.

Returns:

the builder itself

coordBondStyle

public T coordBondStyle(ImageExporter.LineType lineType)

Coordinate bond display style. LineType.DASHED is not accepted.

Parameters:

lineType - LineType.SOLID or LineType.ARROW

Returns:

the builder itself

coordBondStyleAtMulticenter

public T coordBondStyleAtMulticenter(ImageExporter.LineType lineType)

Coordinate bond display style when it connects to a multicenter atom. LineType.ARROW is not accepted.

Parameters:

lineType - LineType.SOLID or LineType.DASHED

Returns:

the builder itself

displayChargeInCircle

public T displayChargeInCircle()

Display charge symbols in a circle.

Returns:

the builder itself

oneLetterPeptide

public T oneLetterPeptide()

Display peptides with their one letter abbreviation instead of the three letter abbreviation which is the default.

Returns:

the builder itself

showAtomProperties

public T showAtomProperties()

Show atom properties.

Returns:

the builder itself

atomFont

public T atomFont(java.lang.String fontType)

Atom font type.

Parameters:

fontType - the font type as a string example: "Times New Roman-PLAIN-12"

Returns:

the builder itself

chargeFont

public T chargeFont(java.lang.String fontType)

Font type in circled charge display.

Parameters:

fontType - the font type as string

Returns:

the builder itself

hideRGroups

public T hideRGroups()

R-groups won't be displayed.

Returns:

the builder itself

bondHashSpacing

public T bondHashSpacing(double spacing)

The spacing of the hash in hashed bonds in C-C bond length units.

Parameters:

spacing - the spacing

Returns:

the builder itself

marginSize

public T marginSize(double size)

Size of the margin in pt.

Parameters:

size - size of the margin in pt

Returns:

the builder itself