org.apache.fop.fo
Class Property.Maker

Direct Known Subclasses:
CharacterProperty.Maker, ColorTypeProperty.Maker, EnumProperty.Maker, LengthProperty.Maker, NumberProperty.Maker, StringProperty.Maker, SVGD.Maker, SVGLengthListProperty.Maker, SVGLengthProperty.Maker, SVGPoints.Maker, SVGStringProperty.Maker, SVGStyle.Maker, SVGTransform.Maker, TextProperty.Maker

public static class Property.Maker


Method Summary
 Propertycompute(PropertyList propertyList)
          Return a Property object representing the value of this property, based on other property values for this FO.
 PercentBasegetPercentBase(FObj fo, PropertyList pl)
          Return an object implementing the PercentBase interface.
 PropertygetSubpropValue(Property p, String subprop)
          Return a property value for the given component of a compound property.
 booleaninheritsSpecified()
          Return a boolean indicating whether this property inherits the "specified" value rather than the "computed" value.
 booleanisInherited()
          Default implementation of isInherited.
 Propertymake(Property baseProp, String partName, PropertyList propertyList, String value, FObj fo)
          Return a property value for a compound property.
 Propertymake(PropertyList propertyList, String value, FObj fo)
          Create a Property object from an attribute specification.
 Propertymake(PropertyList propertyList)
          Return a Property object representing the initial value.

Method Detail

compute

public Property compute(PropertyList propertyList)
Return a Property object representing the value of this property, based on other property values for this FO. A special case is properties which inherit the specified value, rather than the computed value.
Parameters:
propertyList - The PropertyList for the FO.
Returns: Property A computed Property value or null if no rules are specified (in foproperties.xml) to compute the value.

getPercentBase

public PercentBase getPercentBase(FObj fo, PropertyList pl)
Return an object implementing the PercentBase interface. This is used to handle properties specified as a percentage of some "base length", such as the content width of their containing box. Overridden by subclasses which allow percent specifications. See the documentation on properties.xsl for details.

getSubpropValue

public Property getSubpropValue(Property p, String subprop)
Return a property value for the given component of a compound property.
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.

inheritsSpecified

public boolean inheritsSpecified()
Return a boolean indicating whether this property inherits the "specified" value rather than the "computed" value. The default is to inherit the "computed" value.
Returns: If true, property inherits the value specified.

isInherited

public boolean isInherited()
Default implementation of isInherited.
Returns: A boolean indicating whether this property is inherited.

make

public Property make(Property baseProp, String partName, PropertyList propertyList, String value, FObj fo)
throws org.apache.fop.apps.FOPException
Return a property value for a compound property. If the property value is already partially initialized, this method will modify it.
Parameters:
baseProp - The Property object representing the compound property, such as SpaceProperty.
partName - The name of the component whose value is specified.
propertyList - The propertyList being built.
fo - The FO whose properties are being set.
Returns: A compound property object.

make

public Property make(PropertyList propertyList, String value, FObj fo)
throws org.apache.fop.apps.FOPException
Create a Property object from an attribute specification.
Parameters:
propertyList - The PropertyList object being built for this FO.
value - The attribute value.
fo - The current FO whose properties are being set.
Returns: The initialized Property object.

make

public Property make(PropertyList propertyList)
throws org.apache.fop.apps.FOPException
Return a Property object representing the initial value.
Parameters:
propertyList - The PropertyList object being built for this FO.

Association Links

to Class java.lang.String

to Class java.lang.String