|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.foray.common.AbstractOrderedTreeNode
org.foray.fotree.FObj
org.foray.fotree.fo.obj.IndexPageCitationList
public class IndexPageCitationList
An "index-page-citation-list" object in XSL-FO.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class org.foray.common.AbstractOrderedTreeNode |
---|
AbstractOrderedTreeNode.PostOrderDescendantIterator |
Field Summary |
---|
Fields inherited from class org.foray.fotree.FObj |
---|
EMPTY_CHILD_LIST, PAGE_CITATION_TEXT_SEGMENT |
Fields inherited from interface org.axsl.fo.Fo |
---|
DIMENSION_AUTO |
Fields inherited from interface org.axsl.fo.fo.prop.CommonPositionPa |
---|
ABSOLUTE_POSITION_AUTO |
Constructor Summary | |
---|---|
IndexPageCitationList(FObj parent,
PropertyList propertyList)
Constructor. |
Method Summary | |
---|---|
Object |
acceptProxyFactory(org.axsl.fo.ProxyFactory factory)
|
void |
addChild(FObj child)
Add a child to this object. |
protected void |
end()
This method is a hook into the parsing process, primarily to allow the subclass to do some validation or setup work after the object and all of its properties have been parsed and all of its children processed. |
FObj |
getChildAt(int index)
|
List<FObj> |
getChildren()
Return the List of this node's children. |
String |
getName()
|
Namespace |
getNamespace()
Gets the Namespace instance that is associated with this object. |
FObj |
getParent()
|
org.axsl.font.FontUse |
getPrimaryFont(org.axsl.fo.FoContext context)
|
PropertyList |
getPropertyList()
Returns the property list for this FObj. |
boolean |
isContentBlock()
Reports whether the object fits the %block parameter entity described in XSL-FO Std 1.0, Section 6.2. |
boolean |
isContentInline()
Reports whether the object fits the %inline parameter entity described in XSL-FO Std 1.0, Section 6.2. |
boolean |
isContentPcdata()
Reports whether the object fits the #PCDATA content type in XSL-FO Std 1.0, Section 6.2. |
boolean |
isValid()
|
protected void |
setup()
A hook into the parsing process which allows the subclass instance to do some initialization-type work after all of the properties have been parsed, but before any of the children have been parsed. |
protected void |
validateAncestry()
A hook into the parsing process which allows the subclass instance to validate its ancestry. |
protected void |
validateDescendants()
A hook into the parsing process which allows the subclass instance to validate its descendants. |
protected void |
validateProperties()
A hook into the parsing process which allows the subclass instance to validate its properties. |
Methods inherited from class org.foray.common.AbstractOrderedTreeNode |
---|
children, getChildCount, getFirstChild, getFirstLeaf, getIndex, getLastChild, getLastLeaf, getLevel, getNextLeaf, getNextSibling, getPreviousLeaf, getPreviousSibling, getSharedAncestor, hasChildren, isLeaf, isNodeAncestor, isNodeDescendant, nextPostOrderNode, nextPreOrderNode, postOrderDescendantIterator, siblingIndex |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.axsl.fo.Fo |
---|
ancestorBasicLink, ancestorListRelatedObject, ancestorMarker, ancestorTable, getColumn, getContextMessage, getLine, getSequentialIndex, getSystemId, isBlockLevelFo, qtyMarkerChildren, traitIsReferenceArea |
Methods inherited from interface javax.swing.tree.TreeNode |
---|
children, getAllowsChildren, getChildCount, getIndex, isLeaf |
Methods inherited from interface java.lang.Iterable |
---|
iterator |
Methods inherited from interface org.axsl.fo.fo.prop.MergeSequentialPageNumbersPa |
---|
traitMergeSequentialPageNumbers |
Methods inherited from interface org.axsl.fo.fo.prop.MergeRangesAcrossIndexKeyReferencesPa |
---|
traitMergeRangesAcrossIndexKeyReferences |
Methods inherited from interface org.axsl.fo.fo.prop.MergePagesAcrossIndexKeyReferencesPa |
---|
traitMergePagesAcrossIndexKeyReferences |
Constructor Detail |
---|
public IndexPageCitationList(FObj parent, PropertyList propertyList)
parent
- The parent FObj.propertyList
- The property list for this FObj.Method Detail |
---|
protected void validateAncestry() throws org.axsl.fo.FoTreeException
FObj
validateAncestry
in class FObj
org.axsl.fo.FoTreeException
- For invalid ancestry.protected void validateProperties() throws org.axsl.fo.FoTreeException
FObj
validateProperties
in class FObj
org.axsl.fo.FoTreeException
- For invalid properties.protected void setup() throws org.axsl.fo.FoTreeException
FObj
setup
in class FObj
org.axsl.fo.FoTreeException
- For errors during initialization.protected void end() throws org.axsl.fo.FoTreeException
FObj
end
in class FObj
org.axsl.fo.FoTreeException
- For errors during validation or setup.protected void validateDescendants() throws org.axsl.fo.FoTreeException
FObj
validateDescendants
in class FObj
org.axsl.fo.FoTreeException
- For invalid descendants.public String getName()
getName
in interface org.axsl.fo.Fo
getName
in class FObj
public Namespace getNamespace()
FObj
getNamespace
in class FObj
public Object acceptProxyFactory(org.axsl.fo.ProxyFactory factory)
acceptProxyFactory
in interface org.axsl.fo.Fo
public FObj getParent()
getParent
in interface TreeNode
getParent
in interface org.axsl.fo.Fo
getParent
in class FObj
public List<FObj> getChildren()
AbstractOrderedTreeNode
getChildren
in class FObj
public void addChild(FObj child) throws org.axsl.fo.FoTreeException
FObj
addChild
in class FObj
child
- The child to be added.
org.axsl.fo.FoTreeException
- If the child cannot be added as a child for any
reason, either because it an invalid type or is in the wrong order.public boolean isContentInline()
FObj
isContentInline
in class FObj
public boolean isContentBlock()
FObj
isContentBlock
in class FObj
public boolean isContentPcdata()
FObj
isContentPcdata
in class FObj
public PropertyList getPropertyList()
FObj
getPropertyList
in class FObj
public org.axsl.font.FontUse getPrimaryFont(org.axsl.fo.FoContext context)
getPrimaryFont
in interface org.axsl.fo.fo.prop.CommonFontPa
public FObj getChildAt(int index)
getChildAt
in interface TreeNode
getChildAt
in interface org.axsl.fo.Fo
public boolean isValid()
isValid
in interface org.axsl.fo.Fo
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |