org.axsl.fo.fo.prop
Interface ClipPa

All Known Subinterfaces:

BlockContainer, ExternalGraphic, InlineContainer, InstreamForeignObject, Region, RegionAfter, RegionBefore, RegionBody, RegionEnd, RegionStart

public interface ClipPa

The XSL-FO clip property.

Method Summary

java.awt.Shape	traitClip(FoContext context, java.awt.Shape containerShape) Returns the "clip" trait for this FO.
boolean	traitClipIsAuto(FoContext context) Indicates whether the "clip" trait is "auto".

Method Detail

traitClip

java.awt.Shape traitClip(FoContext context,
                         java.awt.Shape containerShape)

Returns the "clip" trait for this FO.

Parameters:

context - An object that knows how to resolve FO Tree context issues.

containerShape - The shape of the actual area in which the clipping will take place. All encapsulated dimensions are expressed in millipoints. This is needed because clipping information can be expressed relative to the container. To avoid unnecessarily computing the Shape of the container, client applications can check traitClipIsAuto(FoContext) first.

Returns:

The shape to which the contents of the area should be clipped, or null for "auto". All encapsulated dimensions are expressed in millipoints.

See Also:

"XSL-FO Standard 1.0, Section 7.20.1", traitClipIsAuto(FoContext)

traitClipIsAuto

boolean traitClipIsAuto(FoContext context)

Indicates whether the "clip" trait is "auto". The typical use of this method is to see whether any clipping is necessary at all before calling traitClip(FoContext, Shape) to get the Shape that should be used for clipping. This allows the client application to avoid computing the shape of the container if it can.

Parameters:

context - An object that knows how to resolve FO Tree context issues.

Returns:

True iff the "clip" trait is set to "auto".

See Also:

traitClip(FoContext, Shape)