org.web3d.x3d.sai.java.Layout

Class LayoutClass

java.lang.Object

org.web3d.x3d.sai.java.Layout.LayoutClass

All Implemented Interfaces:

X3DChildNode, X3DNode, Layout, X3DLayoutNode

public class LayoutClass
extends java.lang.Object
implements Layout

(v3.2 or later) Layout node is used as layout field of LayoutLayer and LayoutGroup nodes. Layout provides all parameters required to define the size, location and scale of a 2D rectangular region. Hint: the align, offset, and offsetUnits fields are used to determine the location of the layout region.

See Also:

X3D Abstract Specification, X3D Tooltips: Layout, X3D Resources, X3D Scene Authoring Hints

Field Summary

Fields inherited from interface org.web3d.x3d.sai.Layout.Layout

ALIGN_DEFAULT_VALUE, OFFSET_DEFAULT_VALUE, OFFSETUNITS_DEFAULT_VALUE, SCALEMODE_DEFAULT_VALUE, SIZE_DEFAULT_VALUE, SIZEUNITS_DEFAULT_VALUE

Constructor Summary

Constructors

Constructor and Description
LayoutClass() Public constructor for LayoutClass to initialize member values

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	getAlign() Provide array of String results from inputOutput MFString field named align.
X3DMetadataObject	getMetadata() Provide X3DMetadataObject value (using a properly typed node or X3DPrototypeInstance) from inputOutput SFNode field named metadata.
float[]	getOffset() Provide array of float results from inputOutput MFFloat field named offset.
java.lang.String[]	getOffsetUnits() Provide array of String results from inputOutput MFString field named offsetUnits.
java.lang.String[]	getScaleMode() Provide array of String results from inputOutput MFString field named scaleMode.
float[]	getSize() Provide array of float results from initializeOnly MFFloat field named size
java.lang.String[]	getSizeUnits() Provide array of String results from inputOutput MFString field named sizeUnits.
void	setAlign(java.lang.String[] value) Assign String array to inputOutput MFString field named align.
void	setMetadata(X3DMetadataObject value) Assign X3DMetadataObject value (using a properly typed node) to inputOutput SFNode field named metadata.
void	setOffset(float[] value) Assign float array to inputOutput MFFloat field named offset.
void	setOffsetUnits(java.lang.String[] value) Assign String array to inputOutput MFString field named offsetUnits.
void	setScaleMode(java.lang.String[] value) Assign String array to inputOutput MFString field named scaleMode.
void	setSize(float[] value) Assign float array to initializeOnly MFFloat field named size
void	setSizeUnits(java.lang.String[] value) Assign String array to inputOutput MFString field named sizeUnits.

Methods inherited from class java.lang.Object

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

Constructor Detail

LayoutClass

public LayoutClass()

Public constructor for LayoutClass to initialize member values

Method Detail

getAlign

public java.lang.String[] getAlign()

Provide array of String results from inputOutput MFString field named align. The align field values align the sized rectangle to an edge or center of the parent rectangle. Two quoted string values are provided. The first value is for horizontal direction (LEFT | CENTER | RIGHT) and the second value is for vertical direction (BOTTOM | CENTER | TOP). Examples: "CENTER" "CENTER" (default value), "LEFT" "TOP" or "RIGHT" "BOTTOM". Warning: two values (or possibly one value) only. Warning: if the align field has only one value, that value shall be "CENTER" and apply both horizontally and vertically. Hint: MFString arrays can have multiple values, so "separate each individual string" "by using quote marks".

Specified by:

getAlign in interface Layout

Returns:

value of align field

setAlign

public void setAlign(java.lang.String[] value)

Assign String array to inputOutput MFString field named align. The align field values align the sized rectangle to an edge or center of the parent rectangle. Two quoted string values are provided. The first value is for horizontal direction (LEFT | CENTER | RIGHT) and the second value is for vertical direction (BOTTOM | CENTER | TOP). Examples: "CENTER" "CENTER" (default value), "LEFT" "TOP" or "RIGHT" "BOTTOM". Warning: two values (or possibly one value) only. Warning: if the align field has only one value, that value shall be "CENTER" and apply both horizontally and vertically. Hint: MFString arrays can have multiple values, so "separate each individual string" "by using quote marks".

Specified by:

setAlign in interface Layout

Parameters:

value - is new value for the field

getMetadata

public X3DMetadataObject getMetadata()

Provide X3DMetadataObject value (using a properly typed node or X3DPrototypeInstance) from inputOutput SFNode field named metadata.

Specified by:

getMetadata in interface X3DChildNode

Specified by:

getMetadata in interface X3DNode

Specified by:

getMetadata in interface Layout

Specified by:

getMetadata in interface X3DLayoutNode

Returns:

value of metadata field

setMetadata

public void setMetadata(X3DMetadataObject value)

Assign X3DMetadataObject value (using a properly typed node) to inputOutput SFNode field named metadata.

Specified by:

setMetadata in interface X3DChildNode

Specified by:

setMetadata in interface X3DNode

Specified by:

setMetadata in interface Layout

Specified by:

setMetadata in interface X3DLayoutNode

Parameters:

value - is new value for the field

getOffset

public float[] getOffset()

Provide array of float results from inputOutput MFFloat field named offset. (-infinity,+infinity) The values of the offset field are used to translate the location of this rectangle after the initial alignment. The offsetUnits field specifies how to interpret the offset field. Warning: two values only.

Specified by:

getOffset in interface Layout

Returns:

value of offset field

setOffset

public void setOffset(float[] value)

Assign float array to inputOutput MFFloat field named offset. (-infinity,+infinity) The values of the offset field are used to translate the location of this rectangle after the initial alignment. The offsetUnits field specifies how to interpret the offset field. Warning: two values only.

Specified by:

setOffset in interface Layout

Parameters:

value - is new value for the field

getOffsetUnits

public java.lang.String[] getOffsetUnits()

Provide array of String results from inputOutput MFString field named offsetUnits. The offsetUnits field values are used to interprete the offset values. Two quoted string values are provided. The first value is for horizontal offset, and the second value is for vertical offset. Examples: "WORLD" "WORLD" (default value), "FRACTION" "FRACTION" or "PIXEL" "PIXEL". Hint: If the value of the offsetUnits field is FRACTION, the size of the corresponding dimension is interpreted as a fraction of the corresponding parent’s dimension. Warning: two values only. Hint: MFString arrays can have multiple values, so "separate each individual string" "by using quote marks".

Specified by:

getOffsetUnits in interface Layout

Returns:

value of offsetUnits field

setOffsetUnits

public void setOffsetUnits(java.lang.String[] value)

Assign String array to inputOutput MFString field named offsetUnits. The offsetUnits field values are used to interprete the offset values. Two quoted string values are provided. The first value is for horizontal offset, and the second value is for vertical offset. Examples: "WORLD" "WORLD" (default value), "FRACTION" "FRACTION" or "PIXEL" "PIXEL". Hint: If the value of the offsetUnits field is FRACTION, the size of the corresponding dimension is interpreted as a fraction of the corresponding parent’s dimension. Warning: two values only. Hint: MFString arrays can have multiple values, so "separate each individual string" "by using quote marks".

Specified by:

setOffsetUnits in interface Layout

Parameters:

value - is new value for the field

getScaleMode

public java.lang.String[] getScaleMode()

Provide array of String results from inputOutput MFString field named scaleMode. The scaleMode field specifies how the scale of the parent is modified. Two quoted string values are provided. The first value is for horizontal scale and the second value is for vertical scale. Examples: "NONE" "NONE" (default value), "FRACTION" "FRACTION", "STRETCH" "STRETCH" or "PIXEL" "PIXEL". Hint: A scaleMode field value of NONE specifies that the corresponding scale value is not modified. Instead, the scale is inherited from its parent. Since a LayoutLayer node does not have a parent, the value of NONE reverts to FRACTION. Hint: A scaleMode value of FRACTION specifies a scale in the corresponding direction so that one unit is equal to the dimension (width or height) of this rectangle. Hint: a scaleMode value of STRETCH specifies a scale in the corresponding direction such that the resulting scale in the horizontal direction is equal to the scale in the vertical direction, thus producing a uniform scale. Hint: a value of PIXEL specifies a scale in the corresponding direction such that one unit is equal to one pixel. Warning: two values only. Hint: MFString arrays can have multiple values, so "separate each individual string" "by using quote marks".

Specified by:

getScaleMode in interface Layout

Returns:

value of scaleMode field

setScaleMode

public void setScaleMode(java.lang.String[] value)

Assign String array to inputOutput MFString field named scaleMode. The scaleMode field specifies how the scale of the parent is modified. Two quoted string values are provided. The first value is for horizontal scale and the second value is for vertical scale. Examples: "NONE" "NONE" (default value), "FRACTION" "FRACTION", "STRETCH" "STRETCH" or "PIXEL" "PIXEL". Hint: A scaleMode field value of NONE specifies that the corresponding scale value is not modified. Instead, the scale is inherited from its parent. Since a LayoutLayer node does not have a parent, the value of NONE reverts to FRACTION. Hint: A scaleMode value of FRACTION specifies a scale in the corresponding direction so that one unit is equal to the dimension (width or height) of this rectangle. Hint: a scaleMode value of STRETCH specifies a scale in the corresponding direction such that the resulting scale in the horizontal direction is equal to the scale in the vertical direction, thus producing a uniform scale. Hint: a value of PIXEL specifies a scale in the corresponding direction such that one unit is equal to one pixel. Warning: two values only. Hint: MFString arrays can have multiple values, so "separate each individual string" "by using quote marks".

Specified by:

setScaleMode in interface Layout

Parameters:

value - is new value for the field

getSize

public float[] getSize()

Provide array of float results from initializeOnly MFFloat field named size. (0,+infinity) The two values in the size field define the width and height of the layout rectangle. The sizeUnits field specifies how to interpret the size values. Warning: two values only.

Specified by:

getSize in interface Layout

Returns:

value of size field

setSize

public void setSize(float[] value)

Assign float array to initializeOnly MFFloat field named size. (0,+infinity) The two values in the size field define the width and height of the layout rectangle. The sizeUnits field specifies how to interpret the size values. Warning: two values only.

Specified by:

setSize in interface Layout

Parameters:

value - is new value for the field

getSizeUnits

public java.lang.String[] getSizeUnits()

Provide array of String results from inputOutput MFString field named sizeUnits. The sizeUnits field values are used to interprete the offset values. Two quoted string values are provided. The first value is for horizontal size, and the second value is for vertical size. Examples: "WORLD" "WORLD" (default value), "FRACTION" "FRACTION" or "PIXEL" "PIXEL". Hint: If the value of the sizeUnits field is FRACTION, the size of the corresponding dimension is interpreted as a fraction of the corresponding parent’s dimension. Warning: two values only. Hint: MFString arrays can have multiple values, so "separate each individual string" "by using quote marks".

Specified by:

getSizeUnits in interface Layout

Returns:

value of sizeUnits field

setSizeUnits

public void setSizeUnits(java.lang.String[] value)

Assign String array to inputOutput MFString field named sizeUnits. The sizeUnits field values are used to interprete the offset values. Two quoted string values are provided. The first value is for horizontal size, and the second value is for vertical size. Examples: "WORLD" "WORLD" (default value), "FRACTION" "FRACTION" or "PIXEL" "PIXEL". Hint: If the value of the sizeUnits field is FRACTION, the size of the corresponding dimension is interpreted as a fraction of the corresponding parent’s dimension. Warning: two values only. Hint: MFString arrays can have multiple values, so "separate each individual string" "by using quote marks".

Specified by:

setSizeUnits in interface Layout

Parameters:

value - is new value for the field