org.foray.area
Class FOLinkageNormal

java.lang.Object
  org.foray.area.FOLinkage
      org.foray.area.FOLinkageNormal

public class FOLinkageNormal
extends FOLinkage

A "normal" linkage manager, that is, one that simply matches an FONode to the Areas that it has created.

Constructor Summary

FOLinkageNormal(org.axsl.fo.Fo foGenerator)
Constructor.

Method Summary

boolean	contains(AreaNode areaNode) Indicates whether a given area was generated by this linkage.
Area	firstNormalAreaReturned() Returns the first normal area returned by this linkage.
AreaNode	getFirstGeneratedBy() Returns the first area generated by this linkage, that is, by the FO node in this linkage.
Area	getLastAreaGeneratedBy() Returns the last Area generated by the FO.
AreaNode	getLastGeneratedBy() Returns the last area node generated by the FO.
AreaNode	getNextGeneratedBy(AreaNode area) For a given area, returns the next area generated by this linkage.
AreaNode	getPreviousGeneratedBy(AreaNode area) For a given area, returns the previous area generated by this linkage.
org.axsl.fo.fo.RetrieveMarker	getRetrieveMarker(AreaNode areaNode) Retrieves the GraftingPoint, if any, for a given area node.
boolean	isFirstGeneratedBy(AreaNode area) Indicates whether a given area is the first one generated by this linkage.
boolean	isLastGeneratedBy(AreaNode area) Indicates whether a given area is the last one generated by this linkage.
Area	lastNormalAreaReturned() Returns the last normal area returned by this linkage.
int	qtyAreasGenerated() Returns the number of areas generated by the FO.
void	registerGeneratedArea(AreaNode areaNode) Register a given area node as being generated by this linkage.
void	unregisterGeneratedArea(AreaNode areaNode) Unregisters a given area node.

Methods inherited from class org.foray.area.FOLinkage

getFONode

Methods inherited from class java.lang.Object

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

Constructor Detail

FOLinkageNormal

public FOLinkageNormal(org.axsl.fo.Fo foGenerator)

Constructor.

Parameters:

foGenerator - The FO node generating this linkage.

Method Detail

registerGeneratedArea

public void registerGeneratedArea(AreaNode areaNode)

Register a given area node as being generated by this linkage.

Parameters:

areaNode - The area node to register.

unregisterGeneratedArea

public void unregisterGeneratedArea(AreaNode areaNode)

Unregisters a given area node.

Parameters:

areaNode - The area node to unregister.

getFirstGeneratedBy

public AreaNode getFirstGeneratedBy()

Returns the first area generated by this linkage, that is, by the FO node in this linkage.

Returns:

The first area generated.

getPreviousGeneratedBy

public AreaNode getPreviousGeneratedBy(AreaNode area)

For a given area, returns the previous area generated by this linkage.

Parameters:

area - The area whose previous area is needed.

Returns:

The previous area, or null, if area is the first area generated by this linkage.

getNextGeneratedBy

public AreaNode getNextGeneratedBy(AreaNode area)

For a given area, returns the next area generated by this linkage.

Parameters:

area - The area whose next area is needed.

Returns:

The next area, or null, if area is the last area generated by this linkage.

isFirstGeneratedBy

public boolean isFirstGeneratedBy(AreaNode area)

Indicates whether a given area is the first one generated by this linkage.

Parameters:

area - An Area instance.

Returns:

True iff area is the first Area generated by this.

isLastGeneratedBy

public boolean isLastGeneratedBy(AreaNode area)

Indicates whether a given area is the last one generated by this linkage.

Parameters:

area - An Area instance.

Returns:

True iff area is the first Area generated by this.

qtyAreasGenerated

public int qtyAreasGenerated()

Returns the number of areas generated by the FO.

Returns:

The current count of areas that have been generated by the FObj.

getLastGeneratedBy

public AreaNode getLastGeneratedBy()

Returns the last area node generated by the FO.

Returns:

The last AreaNode generated by the parent FObj.

getLastAreaGeneratedBy

public Area getLastAreaGeneratedBy()

Returns the last Area generated by the FO.

Returns:

The last Area generated by the parent FObj.

firstNormalAreaReturned

public Area firstNormalAreaReturned()

Returns the first normal area returned by this linkage.

Returns:

The first normal area returned by this linkage.

lastNormalAreaReturned

public Area lastNormalAreaReturned()

Returns the last normal area returned by this linkage.

Returns:

The last normal area returned by this linkage.

getRetrieveMarker

public org.axsl.fo.fo.RetrieveMarker getRetrieveMarker(AreaNode areaNode)

Description copied from class: FOLinkage

Retrieves the GraftingPoint, if any, for a given area node.

Specified by:

getRetrieveMarker in class FOLinkage

Parameters:

areaNode - The area node for which the retrieve marker is needed.

Returns:

The GraftingPoint generating the area, or null.

contains

public boolean contains(AreaNode areaNode)

Indicates whether a given area was generated by this linkage.

Parameters:

areaNode - The node to be tested.

Returns:

True iff this linkage generated areaNode.