FOM Reference > Content > Pages > fLayerGroup interface
  
fLayerGroup interface
This object is used to contain a group of layers on the page, and represents the dpage control stream.
This object inherits from fControl.
LayerMode enumeration
The layer mode.
The LayerMode enumeration has the following constants of type int.
MODE_ENABLED = 0
The layer is enabled.
MODE_DISABLED = 1
The layer is disabled.
MODE_PI_ENABLED = 2
The layer has been enabled during formatting.
MODE_PI_DISABLED = 3
The layer has been disabled during formatting.
layers attribute
An array of all layers in this layer group.
layers
Access
read-only
Returns
fLayer[]
modes attribute
Macro: tplay
An array of values specifying the state of the layer in the equivalent position in the layers array. This array is automatically sized to contain the same amount of elements as the layers array. This value is one of the fLayerGroup-LayerMode constants.
modes
Access
read-only
Returns
fIntArray
addLayer method
Adds the layer to this layer group.
addLayerlayermode
Parameters
fLayerlayer
The layer to add to the group.
intmode
The mode for this layer, one of fLayerGroup.LayerMode.
Returns
fLayer. The newly created layer.
Throws
fContentException
TEMPLATE_READONLY: The template is read only and cannot be changed.
clearLayers method
Deletes all layers from this layer group.
clearLayers
Parameters
None
Returns
void. None.
Throws
fContentException
TEMPLATE_READONLY: The template is read only and cannot be changed.
removeLayer method
Deletes a layer from this layer group.
removeLayerlayer
Parameters
fLayerlayer
The layer to remove from the group.
Returns
void. None.
Throws
fContentException
TEMPLATE_READONLY: The template is read only and cannot be changed.