|
fop 1.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.fop.fo.PropertyList
public abstract class PropertyList
Class containing the collection of properties for a given FObj.
Field Summary | |
---|---|
protected PropertyList |
parentPropertyList
reference to the parent FO's propertyList |
Constructor Summary | |
---|---|
PropertyList(FObj fObjToAttach,
PropertyList parentPropertyList)
Basic constructor. |
Method Summary | |
---|---|
void |
addAttributesToList(org.xml.sax.Attributes attributes)
Adds the attributes, passed in by the parser to the PropertyList |
protected static java.lang.String |
findBasePropertyName(java.lang.String attributeName)
Finds the first or base part (up to any period) of an attribute name. |
protected static java.lang.String |
findSubPropertyName(java.lang.String attributeName)
Finds the second or sub part (portion past any period) of an attribute name. |
Property |
get(int propId)
Return the property on the current FlowObject. |
Property |
get(int propId,
boolean bTryInherit,
boolean bTryDefault)
Return the property on the current FlowObject. |
CommonAbsolutePosition |
getAbsolutePositionProps()
Constructs a CommonAbsolutePosition object. |
CommonAccessibility |
getAccessibilityProps()
Constructs a CommonAccessibility object. |
CommonAural |
getAuralProps()
Constructs a CommonAural object. |
CommonBorderPaddingBackground |
getBorderPaddingBackgroundProps()
Constructs a BorderAndPadding object. |
abstract Property |
getExplicit(int propId)
Return the value explicitly specified on this FO. |
Property |
getExplicitOrShorthand(int propId)
Return the value explicitly specified on this FO. |
FObj |
getFObj()
|
CommonFont |
getFontProps()
Constructs a CommonFont object. |
Property |
getFromParent(int propId)
Return the value of this property on the parent of this FO. |
CommonHyphenation |
getHyphenationProps()
Constructs a CommonHyphenation object. |
Property |
getInherited(int propId)
Return the value of this property inherited by this FO. |
CommonMarginBlock |
getMarginBlockProps()
Constructs a CommonMarginBlock object. |
CommonMarginInline |
getMarginInlineProps()
Constructs a CommonMarginInline object. |
Property |
getNearestSpecified(int propId)
Return the "nearest" specified value for the given property. |
FObj |
getParentFObj()
|
PropertyList |
getParentPropertyList()
|
CommonRelativePosition |
getRelativePositionProps()
Constructs a RelativePositionProps objects. |
CommonTextDecoration |
getTextDecorationProps()
Constructs a CommonTextDecoration object. |
int |
getWritingMode()
Return the "writing-mode" property value. |
int |
getWritingMode(int lrtb,
int rltb,
int tbrl)
Uses the stored writingMode. |
protected void |
handleInvalidProperty(org.apache.xmlgraphics.util.QName attr)
Handles an invalid property. |
protected boolean |
isValidPropertyName(java.lang.String propertyName)
Validates a property name. |
abstract void |
putExplicit(int propId,
Property value)
Set an value defined explicitly on this FO. |
void |
setWritingMode()
Set writing mode for this FO. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected PropertyList parentPropertyList
Constructor Detail |
---|
public PropertyList(FObj fObjToAttach, PropertyList parentPropertyList)
fObjToAttach
- the FO this PropertyList should be attached toparentPropertyList
- the PropertyList belonging to the new objects
parentMethod Detail |
---|
public FObj getFObj()
public FObj getParentFObj()
public PropertyList getParentPropertyList()
public Property getExplicitOrShorthand(int propId) throws PropertyException
propId
- The id of the property whose value is desired.
PropertyException
- ...public abstract Property getExplicit(int propId)
propId
- The ID of the property whose value is desired.
public abstract void putExplicit(int propId, Property value)
propId
- The ID of the property to set.value
- The value of the property.public Property getInherited(int propId) throws PropertyException
propId
- The ID of the property whose value is desired.
PropertyException
- ...public Property get(int propId) throws PropertyException
propId
- The Constants ID of the property whose value is desired.
PropertyException
- if there is a problem evaluating the propertypublic Property get(int propId, boolean bTryInherit, boolean bTryDefault) throws PropertyException
propId
- the property's idbTryInherit
- true for inherited properties, or when the inherited
value is neededbTryDefault
- true when the default value may be used as a last resort
PropertyException
- if there is a problem evaluating the propertypublic Property getNearestSpecified(int propId) throws PropertyException
propId
- The ID of the property whose value is desired.
PropertyException
- if there an error occurred when getting the propertypublic Property getFromParent(int propId) throws PropertyException
propId
- The Constants ID of the property whose value is desired.
PropertyException
- ...public void setWritingMode() throws PropertyException
PropertyException
- ...public int getWritingMode()
public int getWritingMode(int lrtb, int rltb, int tbrl)
lrtb
- the property ID to return under lrtb writingmode.rltb
- the property ID to return under rltb writingmode.tbrl
- the property ID to return under tbrl writingmode.
public void addAttributesToList(org.xml.sax.Attributes attributes) throws ValidationException
attributes
- Collection of attributes passed to us from the parser.
ValidationException
- if there is an attribute that does not
map to a property id (strict validation only)protected boolean isValidPropertyName(java.lang.String propertyName)
propertyName
- the property name to check
protected void handleInvalidProperty(org.apache.xmlgraphics.util.QName attr) throws ValidationException
attr
- the invalid attribute
ValidationException
- if an exception needs to be thrown depending on the
validation settingsprotected static java.lang.String findBasePropertyName(java.lang.String attributeName)
attributeName
- String to be atomized
protected static java.lang.String findSubPropertyName(java.lang.String attributeName)
attributeName
- String to be atomized
public CommonBorderPaddingBackground getBorderPaddingBackgroundProps() throws PropertyException
PropertyException
- if there's a problem while processing the propertiespublic CommonHyphenation getHyphenationProps() throws PropertyException
PropertyException
- if there's a problem while processing the propertiespublic CommonMarginBlock getMarginBlockProps() throws PropertyException
PropertyException
- if there's a problem while processing the propertiespublic CommonMarginInline getMarginInlineProps() throws PropertyException
PropertyException
- if there's a problem while processing the propertiespublic CommonAccessibility getAccessibilityProps() throws PropertyException
PropertyException
- if there's a problem while processing the propertiespublic CommonAural getAuralProps() throws PropertyException
PropertyException
- if there's a problem while processing the propertiespublic CommonRelativePosition getRelativePositionProps() throws PropertyException
PropertyException
- if there's a problem while processing the propertiespublic CommonAbsolutePosition getAbsolutePositionProps() throws PropertyException
PropertyException
- if there's a problem while processing the propertiespublic CommonFont getFontProps() throws PropertyException
PropertyException
- if there's a problem while processing the propertiespublic CommonTextDecoration getTextDecorationProps() throws PropertyException
PropertyException
- if there's a problem while processing the properties
|
fop 1.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |