Class ExternalDocument

Method Details

• bind

  public void bind(PropertyList pList) throws FOPException

  Bind property values from the property list to the FO node. Must be overridden in all FObj subclasses that have properties applying to it.

  Overrides:

  bind in class AbstractPageSequence

  Parameters:

  pList - the PropertyList where the properties can be found.

  Throws:

  FOPException - if there is a problem binding the values

• startOfNode

  public void startOfNode() throws FOPException

  Description copied from class: AbstractPageSequence

  Called after processNode() is called. Subclasses can do additional processing.

  Overrides:

  startOfNode in class AbstractPageSequence

  Throws:

  FOPException - in case of processing exception

  See Also:

  • FONode.startOfNode()

• endOfNode

  public void endOfNode() throws FOPException

  Description copied from class: FObj

  Primarily used for making final content model validation checks and/or informing the FOEventHandler that the end of this FO has been reached. The default implementation simply calls FONode.finalizeNode(), without sending any event to the FOEventHandler.

  Note: the recommended way to override this method in subclasses is

  super.endOfNode(); // invoke finalizeNode()

  getFOEventHandler().endXXX(); // send endOfNode() notification

  Overrides:

  endOfNode in class FObj

  Throws:

  FOPException - in case of processing exception

  See Also:

  • FONode.endOfNode()

• validateChildNode

  protected void validateChildNode(Locator loc, String nsURI, String localName) throws ValidationException

  Description copied from class: FONode

  Checks to make sure, during SAX processing of input document, that the incoming node is valid for this (parent) node (e.g., checking to see that fo:table is not an immediate child of fo:root) called from FOTreeBuilder.startElement(String, String, String, Attributes) before constructing the child FObj.

  Overrides:

  validateChildNode in class FONode

  Parameters:

  loc - a locator

  nsURI - a namespace uri or null

  localName - a local name

  Throws:

  ValidationException - if invalid child

  See Also:

  • FONode.validateChildNode(Locator, String, String)

• getSrc

  public String getSrc()

  Returns the src attribute (the URI to the embedded document).

  Returns:

  the src attribute

• getInlineProgressionDimension

  public LengthRangeProperty getInlineProgressionDimension()

  Specified by:

  getInlineProgressionDimension in interface GraphicsProperties

  Returns:

  the "inline-progression-dimension" property.

• getBlockProgressionDimension

  public LengthRangeProperty getBlockProgressionDimension()

  Specified by:

  getBlockProgressionDimension in interface GraphicsProperties

  Returns:

  the "block-progression-dimension" property.

• getHeight

  public Length getHeight()

  Specified by:

  getHeight in interface GraphicsProperties

  Returns:

  the "height" property.

• getWidth

  public Length getWidth()

  Specified by:

  getWidth in interface GraphicsProperties

  Returns:

  the "width" property.

• getContentHeight

  public Length getContentHeight()

  Specified by:

  getContentHeight in interface GraphicsProperties

  Returns:

  the "content-height" property.

• getContentWidth

  public Length getContentWidth()

  Specified by:

  getContentWidth in interface GraphicsProperties

  Returns:

  the "content-width" property.

• getScaling

  public int getScaling()

  Specified by:

  getScaling in interface GraphicsProperties

  Returns:

  the "scaling" property.

• getOverflow

  public int getOverflow()

  Specified by:

  getOverflow in interface GraphicsProperties

  Returns:

  the "overflow" property.

• getDisplayAlign

  public int getDisplayAlign()

  Specified by:

  getDisplayAlign in interface GraphicsProperties

  Returns:

  the "display-align" property.

• getTextAlign

  public int getTextAlign()

  Specified by:

  getTextAlign in interface GraphicsProperties

  Returns:

  the "text-align" property.

• getNamespaceURI

  public String getNamespaceURI()

  Description copied from class: FObj

  Returns the namespace URI for this node

  Overrides:

  getNamespaceURI in class FObj

  Returns:

  namespace uri

  See Also:

  • FONode.getNamespaceURI()

• getNormalNamespacePrefix

  public String getNormalNamespacePrefix()

  Description copied from class: FObj

  Returns the normally used namespace prefix for this node

  Overrides:

  getNormalNamespacePrefix in class FObj

  Returns:

  namespace prefix

  See Also:

  • FONode.getNormalNamespacePrefix()

• getLocalName

  public String getLocalName()

  Description copied from class: FONode

  Returns the local name (i.e. without namespace prefix) of the node

  Specified by:

  getLocalName in class FONode

  Returns:

  local name

  See Also:

  • FONode.getLocalName()