org.web3d.vrml.nodes
Interface VRMLFontStyleNodeType

All Superinterfaces:

FrameStateListener, VRMLNode, VRMLNodeType

public interface VRMLFontStyleNodeType

extends VRMLNodeType

Describes a font in VRML.

Version:

$Revision: 1.8 $

Author:

Alan Hudson, Justin Couch

Field Summary

static int	BEGIN_JUSTIFY Justify to the beginning
static int	BOLD_STYLE The font style is BOLD
static int	BOLDITALIC_STYLE The font style is BOLDITALIC
static int	END_JUSTIFY Justify to the end of the string
static int	FIRST_JUSTIFY Justify about the first character of the line.
static int	ITALIC_STYLE The font style is ITALIC
static int	MIDDLE_JUSTIFY Justify about the middle
static int	PLAIN_STYLE The font style is PLAIN

Method Summary

java.awt.Font	getFont() Fetch the AWT font description that matches the internal field settings.
int	getHorizontalJustification() Get the horizontal justification flag.
float	getSize() Get the size information for a single line of text.
float	getSpacing() Get the spacing defintion for the lines of text.
int	getVerticalJustification() Get the vertical justification flag.
boolean	isLeftToRight() Get the value of the leftToRight flag.
boolean	isTopToBottom() Get the value of the topToBottom flag.

Methods inherited from interface org.web3d.vrml.nodes.VRMLNodeType

addNodeListener, getFieldValue, getMetadataObject, getRefCount, hasFieldChanged, isSetupFinished, notifyExternProtoLoaded, removeNodeListener, sendRoute, setDEF, setFrameStateManager, setMetadataObject, setupFinished, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, updateRefCount

Methods inherited from interface org.web3d.vrml.lang.VRMLNode

getFieldDeclaration, getFieldIndex, getNodeFieldIndices, getNumFields, getPrimaryType, getSecondaryType, getUserData, getVRMLNodeName, isDEF, setErrorReporter, setUserData, setVersion

Methods inherited from interface org.web3d.vrml.nodes.FrameStateListener

allEventsComplete

Field Detail

PLAIN_STYLE

public static final int PLAIN_STYLE

The font style is PLAIN

See Also:

Constant Field Values

ITALIC_STYLE

public static final int ITALIC_STYLE

The font style is ITALIC

See Also:

Constant Field Values

BOLD_STYLE

public static final int BOLD_STYLE

The font style is BOLD

See Also:

Constant Field Values

BOLDITALIC_STYLE

public static final int BOLDITALIC_STYLE

The font style is BOLDITALIC

See Also:

Constant Field Values

BEGIN_JUSTIFY

public static final int BEGIN_JUSTIFY

Justify to the beginning

See Also:

Constant Field Values

END_JUSTIFY

public static final int END_JUSTIFY

Justify to the end of the string

See Also:

Constant Field Values

MIDDLE_JUSTIFY

public static final int MIDDLE_JUSTIFY

Justify about the middle

See Also:

Constant Field Values

FIRST_JUSTIFY

public static final int FIRST_JUSTIFY

Justify about the first character of the line. FIRST and BEGIN are equivalent values as per VRML spec.

See Also:

Constant Field Values

Method Detail

getFont

public java.awt.Font getFont()

Fetch the AWT font description that matches the internal field settings.

Returns:

The font that is based on the fields

getHorizontalJustification

public int getHorizontalJustification()

Get the horizontal justification flag. Uses the constants defined in this interface. This is the real justification after it has been modified according to the effects of the horizontal field

Returns:

The justfication value

getVerticalJustification

public int getVerticalJustification()

Get the vertical justification flag. Uses the constants defined in this interface. This is the real justification after it has been modified according to the effects of the horizontal field

Returns:

The justfication value

getSpacing

public float getSpacing()

Get the spacing defintion for the lines of text.

Returns:

The font spacing information

getSize

public float getSize()

Get the size information for a single line of text. Font size is already incorporated into the AWT Font information, but may also be needed for the inter-line spacing.

Returns:

The font size information

isTopToBottom

public boolean isTopToBottom()

Get the value of the topToBottom flag. Returns true if the text strings should be rendered from the top first, false for bottom first.

Returns:

true if rendering top to bottom

isLeftToRight

public boolean isLeftToRight()

Get the value of the leftToRight flag. Returns true if the text strings should be rendered from the left side to the right or in reverse - regardless of the original character encoding.

Returns:

true if rendering left to right