org.apache.fop.fo.properties
Class GenericKeep

java.lang.Object
  |
  +--org.apache.fop.fo.Property.Maker
        |
        +--org.apache.fop.fo.KeepProperty.Maker
              |
              +--org.apache.fop.fo.properties.GenericKeep

Direct Known Subclasses:

KeepTogetherMaker, KeepWithNextMaker, KeepWithPreviousMaker

public class GenericKeep

extends KeepProperty.Maker

Inner Class Summary

static interface

GenericKeep.Enums

Constructor Summary

protected

GenericKeep(java.lang.String name)

Method Summary

Property	checkEnumValues(java.lang.String value)
Property	convertProperty(Property p, PropertyList pList, FObj fo) Set the appropriate components when the "base" property is set.
protected java.lang.String	getDefaultForWithinColumn()
protected java.lang.String	getDefaultForWithinLine()
protected java.lang.String	getDefaultForWithinPage()
protected Property.Maker	getSubpropMaker(java.lang.String subprop) Return a Maker object which is used to set the values on components of compound property types, such as "space".
Property	getSubpropValue(Property baseProp, java.lang.String subpropName) Return a property value for the given component of a compound property.
protected boolean	isCompoundMaker()
Property	make(PropertyList propertyList) Return a Property object representing the initial value.
protected Property	makeCompound(PropertyList pList, FObj fo) Return a Property object representing the initial value.
static Property.Maker	maker(java.lang.String propName)
protected Property	setSubprop(Property baseProp, java.lang.String subpropName, Property subProp) Set a component in a compound property and return the modified compound property object.

Methods inherited from class org.apache.fop.fo.Property.Maker

checkValueKeywords, compute, convertPropertyDatatype, convertShorthandProperty, getPercentBase, getPropName, getShorthand, inheritsSpecified, isCorrespondingForced, isInherited, make, make

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericKeep

protected GenericKeep(java.lang.String name)

Method Detail

maker

public static Property.Maker maker(java.lang.String propName)

checkEnumValues

public Property checkEnumValues(java.lang.String value)

Overrides:

checkEnumValues in class Property.Maker

isCompoundMaker

protected boolean isCompoundMaker()

Overrides:

isCompoundMaker in class Property.Maker

getSubpropMaker

protected Property.Maker getSubpropMaker(java.lang.String subprop)

Description copied from class: Property.Maker

Return a Maker object which is used to set the values on components of compound property types, such as "space". Overridden by property maker subclasses which handle compound properties.

Overrides:

getSubpropMaker in class Property.Maker

Following copied from class: org.apache.fop.fo.Property.Maker

Parameters:

subprop - The name of the component for which a Maker is to returned, for example "optimum", if the FO attribute is space.optimum='10pt'.

setSubprop

protected Property setSubprop(Property baseProp,
                              java.lang.String subpropName,
                              Property subProp)

Description copied from class: Property.Maker

Set a component in a compound property and return the modified compound property object. This default implementation returns the original base property without modifying it. It is overridden by property maker subclasses which handle compound properties.

Overrides:

setSubprop in class Property.Maker

Following copied from class: org.apache.fop.fo.Property.Maker

Parameters:

baseProp - The Property object representing the compound property, such as SpaceProperty.

partName - The name of the component whose value is specified.

subProp - A Property object holding the specified value of the component to be set.

Returns:

The modified compound property object.

getSubpropValue

public Property getSubpropValue(Property baseProp,
                                java.lang.String subpropName)

Description copied from class: Property.Maker

Return a property value for the given component of a compound property.

Overrides:

getSubpropValue in class Property.Maker

Following copied from class: org.apache.fop.fo.Property.Maker

Parameters:

p - A property value for a compound property type such as SpaceProperty.

subprop - The name of the component whose value is to be returned. NOTE: this is only to ease porting when calls are made to PropertyList.get() using a component name of a compound property, such as get("space.optimum"). The recommended technique is: get("space").getOptimum(). Overridden by property maker subclasses which handle compound properties.

make

public Property make(PropertyList propertyList)
              throws FOPException

Description copied from class: Property.Maker

Return a Property object representing the initial value.

Overrides:

make in class Property.Maker

Following copied from class: org.apache.fop.fo.Property.Maker

Parameters:

propertyList - The PropertyList object being built for this FO.

makeCompound

protected Property makeCompound(PropertyList pList,
                                FObj fo)
                         throws FOPException

Description copied from class: Property.Maker

Return a Property object representing the initial value.

Overrides:

makeCompound in class Property.Maker

Following copied from class: org.apache.fop.fo.Property.Maker

Parameters:

propertyList - The PropertyList object being built for this FO.

parentFO - The parent FO for the FO whose property is being made.

Returns:

a Property subclass object holding a "compound" property object initialized to the default values for each component.

getDefaultForWithinPage

protected java.lang.String getDefaultForWithinPage()

getDefaultForWithinLine

protected java.lang.String getDefaultForWithinLine()

getDefaultForWithinColumn

protected java.lang.String getDefaultForWithinColumn()

convertProperty

public Property convertProperty(Property p,
                                PropertyList pList,
                                FObj fo)
                         throws FOPException

Set the appropriate components when the "base" property is set.

Overrides:

convertProperty in class Property.Maker

Following copied from class: org.apache.fop.fo.Property.Maker

Parameters:

p - The Property object return by the expression parser

propertyList - The PropertyList object being built for this FO.

fo - The current FO whose properties are being set.

Returns:

A Property of the correct type or null if the parsed value can't be converted to the correct type.