SourceForge.net Logo
aXSL API 0.2

org.axsl.fo.fo.prop
Interface CommonMarginBlockPa

All Known Subinterfaces:
Block, BlockContainer, ListBlock, ListItem, RegionBody, SimplePageMaster, Table, TableAndCaption

public interface CommonMarginBlockPa

The XSL-FO Common Margin Properties--Block. Note the absence of methods for the margin-left, margin-right, margin-top, and margin-bottom properties that are documented in the XSL-FO Recommendation. Implementations support these properties at parse time, but normalize the values in those properties to the equivalent space-before, space-after, space-start, or space-end properties.

See Also:
"XSL-FO, 1.1, Section 7.11."

Method Summary
 int traitEndIndent(FoContext context)
          Returns the "end-indent" trait for this FO.
 Conditionality traitSpaceAfterConditionality(FoContext context)
          Returns the "conditionality" component of the "space-after" trait for this FO.
 int traitSpaceAfterMaximum(FoContext context)
          Returns the "maximum" component of the "space-after" trait for this FO.
 int traitSpaceAfterMinimum(FoContext context)
          Returns the "minimum" component of the "space-after" trait for this FO.
 int traitSpaceAfterOptimum(FoContext context)
          Returns the "optimum" component of the "space-after" trait for this FO.
 int traitSpaceAfterPrecedence()
          Returns the "precedence" component of the "space-after" trait for this FO.
 Conditionality traitSpaceBeforeConditionality(FoContext context)
          Returns the "conditionality" component of the "space-before" trait for this FO.
 int traitSpaceBeforeMaximum(FoContext context)
          Returns the "maximum" component of the "space-before" trait for this FO.
 int traitSpaceBeforeMinimum(FoContext context)
          Returns the "minimum" component of the "space-before" trait for this FO.
 int traitSpaceBeforeOptimum(FoContext context)
          Returns the "optimum" component of the "space-before" trait for this FO.
 int traitSpaceBeforePrecedence()
          Returns the "precedence" component of the "space-before" trait for this FO.
 int traitStartIndent(FoContext context)
          Returns the "start-indent" trait for this FO.
 

Method Detail

traitSpaceBeforeMinimum

int traitSpaceBeforeMinimum(FoContext context)
Returns the "minimum" component of the "space-before" trait for this FO.

Parameters:
context - An object that knows how to resolve FO Tree context issues.
Returns:
The "minimum" component of the "space-before" trait for this FO, in millipoints.
See Also:
"XSL-FO Standard 1.0, Section 7.10.5", "XSL-FO Standard 1.0, Section 4.3"

traitSpaceBeforeOptimum

int traitSpaceBeforeOptimum(FoContext context)
Returns the "optimum" component of the "space-before" trait for this FO.

Parameters:
context - An object that knows how to resolve FO Tree context issues.
Returns:
The "optimum" component of the "space-before" trait for this FO, in millipoints.
See Also:
"XSL-FO Standard 1.0, Section 7.10.5", "XSL-FO Standard 1.0, Section 4.3"

traitSpaceBeforeMaximum

int traitSpaceBeforeMaximum(FoContext context)
Returns the "maximum" component of the "space-before" trait for this FO.

Parameters:
context - An object that knows how to resolve FO Tree context issues.
Returns:
The "maximum" component of the "space-before" trait for this FO, in millipoints.
See Also:
"XSL-FO Standard 1.0, Section 7.10.5", "XSL-FO Standard 1.0, Section 4.3"

traitSpaceBeforeConditionality

Conditionality traitSpaceBeforeConditionality(FoContext context)
Returns the "conditionality" component of the "space-before" trait for this FO.

Parameters:
context - An object that knows how to resolve FO Tree context issues.
Returns:
The space-before conditionality.
See Also:
"XSL-FO Standard 1.0, Section 7.10.5", "XSL-FO Standard 1.0, Section 4.3"

traitSpaceBeforePrecedence

int traitSpaceBeforePrecedence()
Returns the "precedence" component of the "space-before" trait for this FO.

Returns:
The space-before precedence. A higher value indicates a higher precedence for this condition. The keyword value "force" will be returned as Integer.MAX_VALUE.
See Also:
"XSL-FO Standard 1.0, Section 7.10.5", "XSL-FO Standard 1.0, Section 4.3"

traitSpaceAfterMinimum

int traitSpaceAfterMinimum(FoContext context)
Returns the "minimum" component of the "space-after" trait for this FO.

Parameters:
context - An object that knows how to resolve FO Tree context issues.
Returns:
The "minimum" component of the "space-after" trait for this FO, in millipoints.
See Also:
"XSL-FO Standard 1.0, Section 7.10.6", "XSL-FO Standard 1.0, Section 4.3"

traitSpaceAfterOptimum

int traitSpaceAfterOptimum(FoContext context)
Returns the "optimum" component of the "space-after" trait for this FO.

Parameters:
context - An object that knows how to resolve FO Tree context issues.
Returns:
The "optimum" component of the "space-after" trait for this FO, in millipoints.
See Also:
"XSL-FO Standard 1.0, Section 7.10.6", "XSL-FO Standard 1.0, Section 4.3"

traitSpaceAfterMaximum

int traitSpaceAfterMaximum(FoContext context)
Returns the "maximum" component of the "space-after" trait for this FO.

Parameters:
context - An object that knows how to resolve FO Tree context issues.
Returns:
The "maximum" component of the "space-after" trait for this FO, in millipoints.
See Also:
"XSL-FO Standard 1.0, Section 7.10.6", "XSL-FO Standard 1.0, Section 4.3"

traitSpaceAfterConditionality

Conditionality traitSpaceAfterConditionality(FoContext context)
Returns the "conditionality" component of the "space-after" trait for this FO.

Parameters:
context - An object that knows how to resolve FO Tree context issues.
Returns:
The space-after conditionality.
See Also:
"XSL-FO Standard 1.0, Section 7.10.6", "XSL-FO Standard 1.0, Section 4.3"

traitSpaceAfterPrecedence

int traitSpaceAfterPrecedence()
Returns the "precedence" component of the "space-after" trait for this FO.

Returns:
The space-after precedence. A higher value indicates a higher precedence for this condition. The keyword value "force" will be returned as Integer.MAX_VALUE.
See Also:
"XSL-FO Standard 1.0, Section 7.10.6", "XSL-FO Standard 1.0, Section 4.3"

traitStartIndent

int traitStartIndent(FoContext context)
Returns the "start-indent" trait for this FO.

Parameters:
context - An object that knows how to resolve FO Tree context issues.
Returns:
The start-indent value, in millipoints.
See Also:
"XSL-FO Standard 1.0, Section 7.10.7"

traitEndIndent

int traitEndIndent(FoContext context)
Returns the "end-indent" trait for this FO.

Parameters:
context - An object that knows how to resolve FO Tree context issues.
Returns:
The end-indent value, in millipoints.
See Also:
"XSL-FO Standard 1.0, Section 7.10.8"

SourceForge.net Logo
aXSL API 0.2

This documentation was created August 8 2007 by The aXSL Group and may be freely copied. See license for details.