Package org.web3d.vrml.renderer.common.nodes.layout

Class BaseBorderLayout

java.lang.Object

org.web3d.vrml.renderer.common.nodes.AbstractNode

org.web3d.vrml.renderer.common.nodes.layout.BaseSurfaceChildNode

org.web3d.vrml.renderer.common.nodes.layout.BaseSurfaceLayoutNode

org.web3d.vrml.renderer.common.nodes.layout.BaseBorderLayout

All Implemented Interfaces:

VRMLNode, FrameStateListener, VRMLNodeType, VRMLSurfaceChildNodeType, VRMLSurfaceLayoutListener, VRMLSurfaceLayoutNodeType

Direct Known Subclasses:

NRBorderLayout

public abstract class BaseBorderLayout
extends BaseSurfaceLayoutNode

Common implementation of a BorderLayout node.

A border layout places the contained children relative to the border using an alignment and fraction setup. It operates on the two axis, screen coordinate setup.

Because this layout only has a single set of conditions, yet has many children, it does not make sense to have more than one child node actually assigned. If more than one child is provided, the layout will place them all at the same position wrt the alignment requirements.

Version:

$Revision: 1.2 $

Author:

Justin Couch

Field Summary

Fields

Modifier and Type	Field	Description
protected static final Map<String,Integer>	alignmentMap	Mapping of valid field values to their Integer ID equivalents
protected static final org.j3d.util.HashSet<String>	allowedHorizontalValues	Set of allowed horizontal alignment field values
protected static final org.j3d.util.HashSet<String>	allowedVerticalValues	Set of allowed vertical alignment field values
protected static final String	BOTTOM	The field value for the BOTTOM vertical alignment
protected static final int	BOTTOM_ALIGN	The internal ID value for the BOTTOM vertical alignment
protected static final String	CENTER	The field value for the CENTER horizontal and vertical alignments
protected static final int	CENTER_ALIGN	The internal ID value for the CENTER horizontal and vertical alignments
protected static final int	FIELD_HORIZONTAL_ALIGN	The field index for horizontalAlign.
protected static final int	FIELD_HORIZONTAL_FRACTION	The field index for horizontalFraction.
protected static final int	FIELD_VERTICAL_ALIGN	The field index for verticalAlign.
protected static final int	FIELD_VERTICAL_FRACTION	The field index for verticalFraction.
protected static final int	LAST_BORDER_LAYOUT_INDEX	The last field index used by this class
protected static final String	LEFT	The field value for the LEFT horizontal alignment
protected static final int	LEFT_ALIGN	The internal ID value for the LEFT horizontal alignment
protected static final int	NUM_FIELDS	Number of fields constant
protected static final String	RIGHT	The field value for the RIGHT horizontal alignment
protected static final int	RIGHT_ALIGN	The internal ID value for the RIGHT horizontal alignment
protected static final String	TOP	The field value for the TOP vertical alignment
protected static final int	TOP_ALIGN	The internal ID value for the TOP vertical alignment
protected String	vfHorizontalAlign	The value of the horizontalAlign field.
protected float	vfHorizontalFraction	The value of the horizontalFraction field.
protected String	vfVerticalAlign	The value of the verticalAlign field.
protected float	vfVerticalFraction	The value of the verticalFraction field.

Fields inherited from class org.web3d.vrml.renderer.common.nodes.layout.BaseSurfaceLayoutNode

BAD_NODE_MSG, BAD_PROTO_MSG, FIELD_CHILDREN, LAST_LAYOUT_INDEX, vfChildren

Fields inherited from class org.web3d.vrml.renderer.common.nodes.layout.BaseSurfaceChildNode

FIELD_BBOX_SIZE, FIELD_VISIBLE, LAST_SURFACE_CHILD_INDEX, listener, parentVisibility, screenBounds, screenLocation, vfBboxSize, vfVisible

Fields inherited from class org.web3d.vrml.renderer.common.nodes.AbstractNode

errorReporter, FIELD_METADATA, fieldLocalData, hasChanged, inSetup, isDEF, isStatic, LAST_NODE_INDEX, layerIds, nodeName, pMetadata, refCounts, removedLayerIds, stateManager, STATIC_SCENE_GRAPH, vfMetadata, vrmlMajorVersion, vrmlMinorVersion

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaseBorderLayout()	Construct a new default Overlay object
protected	BaseBorderLayout(VRMLNodeType node)	Construct a new instance of this node based on the details from the given node.

Method Summary

Modifier and Type	Method	Description
VRMLFieldDeclaration	getFieldDeclaration(int index)	Get the declaration of the field at the given index.
int	getFieldIndex(String fieldName)	Get the index of the given field name.
VRMLFieldData	getFieldValue(int index)	Get the value of a field.
int[]	getNodeFieldIndices()	Get the list of indices that correspond to fields that contain nodes ie MFNode and SFNode).
int	getNumFields()	Get the number of fields.
void	sendRoute(double time, int srcIndex, VRMLNodeType destNode, int destIndex)	Send a routed value from this node to the given destination node.
void	setLocation(int x, int y)	Tell this overlay that it's position in window coordinates has been changed to this new value.
void	setupFinished()	Notification that the construction phase of this node has finished.
void	setValue(int index, float value)	Set the value of the field at the given index as a float.
void	setValue(int index, String value)	Set the value of the field at the given index as a string.
protected void	updateManagedNodes()	Convenience method to update the children node(s) to the new positions.

Methods inherited from class org.web3d.vrml.renderer.common.nodes.layout.BaseSurfaceLayoutNode

appendNode, getChildren, getPrimaryType, setChildren, setParentVisible, setValue, setValue, setVisible, surfaceResized, windowChanged

Methods inherited from class org.web3d.vrml.renderer.common.nodes.layout.BaseSurfaceChildNode

copy, fireSizeChange, getBboxSize, getParentVisible, getRealBounds, isVisible, setBboxSize, setLayoutListener, setValue, setValue

Methods inherited from class org.web3d.vrml.renderer.common.nodes.AbstractNode

addNodeListener, allEventsComplete, checkNodeType, checkSecondaryType, checkSecondaryType, clearRemovedLayerIds, fireFieldChanged, getLayerIds, getMetadataObject, getRefCount, getRemovedLayerIds, getSecondaryType, getUserData, getVRMLNodeName, hasFieldChanged, isDEF, isSetupFinished, notifyExternProtoLoaded, removeNodeListener, setDEF, setErrorReporter, setFrameStateManager, setMetadataObject, setUserData, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setVersion, throwInitOnlyWriteException, throwInputOnlyWriteException, throwInvalidNodeException, throwInvalidProtoException, throwOutputOnlyWriteException, updateRefCount, updateRefs

Methods inherited from class java.lang.Object

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

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

allEventsComplete

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

getSecondaryType, getUserData, getVRMLNodeName, isDEF, setErrorReporter, setUserData, setVersion

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

addNodeListener, clearRemovedLayerIds, getLayerIds, getMetadataObject, getRefCount, getRemovedLayerIds, hasFieldChanged, isSetupFinished, notifyExternProtoLoaded, removeNodeListener, setDEF, setFrameStateManager, setMetadataObject, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, updateRefCount

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

getBboxSize, getParentVisible, getRealBounds, isVisible, setLayoutListener

Field Details

FIELD_HORIZONTAL_ALIGN

protected static final int FIELD_HORIZONTAL_ALIGN

The field index for horizontalAlign.

See Also:

• Constant Field Values

FIELD_VERTICAL_ALIGN

protected static final int FIELD_VERTICAL_ALIGN

The field index for verticalAlign.

See Also:

• Constant Field Values

FIELD_HORIZONTAL_FRACTION

protected static final int FIELD_HORIZONTAL_FRACTION

The field index for horizontalFraction.

See Also:

• Constant Field Values

FIELD_VERTICAL_FRACTION

protected static final int FIELD_VERTICAL_FRACTION

The field index for verticalFraction.

See Also:

• Constant Field Values

LAST_BORDER_LAYOUT_INDEX

protected static final int LAST_BORDER_LAYOUT_INDEX

The last field index used by this class

See Also:

• Constant Field Values

NUM_FIELDS

protected static final int NUM_FIELDS

Number of fields constant

See Also:

• Constant Field Values

LEFT

protected static final String LEFT

The field value for the LEFT horizontal alignment

See Also:

• Constant Field Values

RIGHT

protected static final String RIGHT

The field value for the RIGHT horizontal alignment

See Also:

• Constant Field Values

CENTER

protected static final String CENTER

The field value for the CENTER horizontal and vertical alignments

See Also:

• Constant Field Values

TOP

protected static final String TOP

The field value for the TOP vertical alignment

See Also:

• Constant Field Values

BOTTOM

protected static final String BOTTOM

The field value for the BOTTOM vertical alignment

See Also:

• Constant Field Values

LEFT_ALIGN

protected static final int LEFT_ALIGN

The internal ID value for the LEFT horizontal alignment

See Also:

• Constant Field Values

RIGHT_ALIGN

protected static final int RIGHT_ALIGN

The internal ID value for the RIGHT horizontal alignment

See Also:

• Constant Field Values

CENTER_ALIGN

protected static final int CENTER_ALIGN

The internal ID value for the CENTER horizontal and vertical alignments

See Also:

• Constant Field Values

TOP_ALIGN

protected static final int TOP_ALIGN

The internal ID value for the TOP vertical alignment

See Also:

• Constant Field Values

BOTTOM_ALIGN

protected static final int BOTTOM_ALIGN

The internal ID value for the BOTTOM vertical alignment

See Also:

• Constant Field Values

alignmentMap

protected static final Map<String,Integer> alignmentMap

Mapping of valid field values to their Integer ID equivalents

allowedHorizontalValues

protected static final org.j3d.util.HashSet<String> allowedHorizontalValues

Set of allowed horizontal alignment field values

allowedVerticalValues

protected static final org.j3d.util.HashSet<String> allowedVerticalValues

Set of allowed vertical alignment field values

vfHorizontalAlign

protected String vfHorizontalAlign

The value of the horizontalAlign field.

vfVerticalAlign

protected String vfVerticalAlign

The value of the verticalAlign field.

vfHorizontalFraction

protected float vfHorizontalFraction

The value of the horizontalFraction field.

vfVerticalFraction

protected float vfVerticalFraction

The value of the verticalFraction field.

Constructor Details

BaseBorderLayout

protected BaseBorderLayout()

Construct a new default Overlay object

BaseBorderLayout

protected BaseBorderLayout(VRMLNodeType node)

Construct a new instance of this node based on the details from the given node. If the node is not the same type, an exception will be thrown.

Parameters:

node - The node to copy

Throws:

IllegalArgumentException - The node is not the same type

Method Details

setupFinished

public void setupFinished()

Notification that the construction phase of this node has finished. If the node would like to do any internal processing, such as setting up geometry, then go for it now.

Specified by:

setupFinished in interface VRMLNodeType

Overrides:

setupFinished in class BaseSurfaceLayoutNode

getFieldIndex

public int getFieldIndex(String fieldName)

Get the index of the given field name. If the name does not exist for this node then return a value of -1.

Parameters:

fieldName - The name of the field we want the index from

Returns:

The index of the field name or -1

getNodeFieldIndices

public int[] getNodeFieldIndices()

Get the list of indices that correspond to fields that contain nodes ie MFNode and SFNode). Used for blind scene graph traversal without needing to spend time querying for all fields etc. If a node does not have any fields that contain nodes, this shall return null. The field list covers all field types, regardless of whether they are readable or not at the VRML-level.

Returns:

The list of field indices that correspond to SF/MFnode fields or null if none

getFieldDeclaration

public VRMLFieldDeclaration getFieldDeclaration(int index)

Get the declaration of the field at the given index. This allows for reverse lookup if needed. If the field does not exist, this will give a value of null.

Parameters:

index - The index of the field to get information

Returns:

A representation of this field's information

getNumFields

public int getNumFields()

Get the number of fields.

Returns:

The number of fields.

getFieldValue

public VRMLFieldData getFieldValue(int index)
                            throws InvalidFieldException

Get the value of a field. If the field is a primitive type, it will return a class representing the value. For arrays or nodes it will return the instance directly.

Specified by:

getFieldValue in interface VRMLNodeType

Overrides:

getFieldValue in class BaseSurfaceLayoutNode

Parameters:

index - The index of the field to change.

Returns:

The class representing the field value

Throws:

InvalidFieldException - The field index is not known

sendRoute

public void sendRoute(double time,
 int srcIndex,
 VRMLNodeType destNode,
 int destIndex)

Send a routed value from this node to the given destination node. The route should use the appropriate setValue() method of the destination node. It should not attempt to cast the node up to a higher level. Routing should also follow the standard rules for the loop breaking and other appropriate rules for the specification.

Specified by:

sendRoute in interface VRMLNodeType

Overrides:

sendRoute in class BaseSurfaceLayoutNode

Parameters:

time - The time that this route occurred (not necessarily epoch time. Should be treated as a relative value only)

srcIndex - The index of the field in this node that the value should be sent from

destNode - The node reference that we will be sending the value to

destIndex - The index of the field in the destination node that the value should be sent to.

setValue

public void setValue(int index,
 float value)
              throws InvalidFieldException

Set the value of the field at the given index as a float. This would be used to set SFFloat field types.

Specified by:

setValue in interface VRMLNodeType

Overrides:

setValue in class AbstractNode

Parameters:

index - The index of destination field to set

value - The new value to use for the field

Throws:

InvalidFieldException - The field index is not know

setValue

public void setValue(int index,
 String value)
              throws InvalidFieldException

Set the value of the field at the given index as a string. This would be used to set SFString field types.

Specified by:

setValue in interface VRMLNodeType

Overrides:

setValue in class AbstractNode

Parameters:

index - The index of destination field to set

value - The new value to use for the field

Throws:

InvalidFieldException - The field index is not know

setLocation

public void setLocation(int x,
 int y)

Tell this overlay that it's position in window coordinates has been changed to this new value. The position is always that of the top-left corner of the bounding box in screen coordinate space.

Specified by:

setLocation in interface VRMLSurfaceChildNodeType

Overrides:

setLocation in class BaseSurfaceChildNode

Parameters:

x - The x location of the window in pixels

y - The y location of the window in pixels

updateManagedNodes

protected void updateManagedNodes()

Convenience method to update the children node(s) to the new positions. The position may have changed because the window size changed, or the alignment fractions have changed. Derived classes may override this method but should call this as well to make sure the correct values are updated.

Overrides:

updateManagedNodes in class BaseSurfaceLayoutNode