Method Detail

• newInstance

  public static StructureTreeEventHandler newInstance​(org.xml.sax.ContentHandler contentHandler)

  Factory method that creates a new instance.

  Parameters:

  contentHandler - The handler that receives SAX events

  Returns:

  -

• startPageSequence

  public void startPageSequence​(java.util.Locale locale,
                                java.lang.String role)

  Starts a page sequence structure tree node.

  Specified by:

  startPageSequence in interface StructureTreeEventHandler

  Parameters:

  locale - The locale of the page sequence

  role - the value of the role property. May be null.

• endPageSequence

  public void endPageSequence()

  Ends a page sequence structure tree node.

  Specified by:

  endPageSequence in interface StructureTreeEventHandler

• startNode

  public StructureTreeElement startNode​(java.lang.String name,
                                        org.xml.sax.Attributes attributes,
                                        StructureTreeElement parent)

  Starts a structure tree node.

  Specified by:

  startNode in interface StructureTreeEventHandler

  Parameters:

  name - the name of the structure tree node

  attributes - the node properties

  parent - the parent of the node. May be null, in which case the parent node is the node corresponding to the previous call to this method

  Returns:

  the corresponding structure tree element

• endNode

  public void endNode​(java.lang.String name)

  Ends a structure tree node.

  Specified by:

  endNode in interface StructureTreeEventHandler

  Parameters:

  name - the name of the structure tree node

• startImageNode

  public StructureTreeElement startImageNode​(java.lang.String name,
                                             org.xml.sax.Attributes attributes,
                                             StructureTreeElement parent)

  Starts an image node.

  Specified by:

  startImageNode in interface StructureTreeEventHandler

  Parameters:

  name - the name of the structure tree node

  attributes - the node properties

  parent - the parent of the node. May be null, in which case the parent node is the node corresponding to the previous call to this method

  Returns:

  the corresponding structure tree element

• startReferencedNode

  public StructureTreeElement startReferencedNode​(java.lang.String name,
                                                  org.xml.sax.Attributes attributes,
                                                  StructureTreeElement parent)

  Starts a node that can be referenced by other nodes. This is usually a node that can have Marked Content References as children.

  Specified by:

  startReferencedNode in interface StructureTreeEventHandler

  Parameters:

  name - the name of the structure tree node

  attributes - the node properties

  parent - the parent of the node. May be null, in which case the parent node is the node corresponding to the previous call to this method

  Returns:

  the corresponding structure tree element