Package org.apache.fop.fo.flow.table

Class TableRow

    • Constructor Detail

      • TableRow

        public TableRow​(FONode parent)
        Create a TableRow instance with the given FONode as parent.
        Parameters:
        parent - FONode that is the parent of this object

    • Method Detail

      • 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 TableCellContainer
        Parameters:
        pList - the PropertyList where the properties can be found.
        Throws:
        FOPException - if there is a problem binding the values

      • processNode

        public void processNode​(java.lang.String elementName,
                        org.xml.sax.Locator locator,
                        org.xml.sax.Attributes attlist,
                        PropertyList pList)
                 throws FOPException
        Initialize the node with its name, location information, and attributes The attributes must be used immediately as the sax attributes will be altered for the next element.
        Overrides:
        processNode in class TableFObj
        Parameters:
        elementName - element name (e.g., "fo:block")
        locator - Locator object (ignored by default)
        attlist - Collection of attributes passed to us from the parser.
        pList - the property list of the parent node
        Throws:
        FOPException - for errors or inconsistencies in the attributes

      • addChildNode

        protected void addChildNode​(FONode child)
                     throws FOPException
        Adds a node as a child of this node. The default implementation of this method just ignores any child node being added.
        Overrides:
        addChildNode in class FObj
        Parameters:
        child - child node to be added to the childNodes of this node
        Throws:
        FOPException - if there's a problem during processing

      • startOfNode

        public void startOfNode()
                 throws FOPException
        Called after processNode() is called. Subclasses can do additional processing.
        Overrides:
        startOfNode in class FObj
        Throws:
        FOPException - FOP Exception

      • endOfNode

        public void endOfNode()
               throws FOPException
        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 - FOP Exception

      • finalizeNode

        public void finalizeNode()
                  throws FOPException
        Finalize this node. This method can be overridden by subclasses to perform finishing tasks (cleanup, validation checks, ...) without triggering endXXX() events in the FOEventHandler. The method is called by the default FONode.endOfNode() implementation.
        Overrides:
        finalizeNode in class FONode
        Throws:
        FOPException - in case there was an error

      • validateChildNode

        protected void validateChildNode​(org.xml.sax.Locator loc,
                                 java.lang.String nsURI,
                                 java.lang.String localName)
                          throws ValidationException
        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. String, String)
        XSL Content Model: (table-cell+)
        Overrides:
        validateChildNode in class FONode
        Parameters:
        loc - location in the FO source file
        nsURI - namespace of incoming node
        localName - name of the incoming node (without namespace prefix)
        Throws:
        ValidationException - if incoming node not valid for parent

      • getKeepWithPrevious

        public KeepProperty getKeepWithPrevious()
        Returns:
        the "keep-with-previous" property.

      • getKeepWithNext

        public KeepProperty getKeepWithNext()
        Returns:
        the "keep-with-next" property.

      • getKeepTogether

        public KeepProperty getKeepTogether()
        Returns:
        the "keep-together" property.

      • mustKeepTogether

        public boolean mustKeepTogether()
        Convenience method to check if a keep-together constraint is specified.
        Returns:
        true if keep-together is active.

      • mustKeepWithNext

        public boolean mustKeepWithNext()
        Convenience method to check if a keep-with-next constraint is specified.
        Returns:
        true if keep-with-next is active.

      • mustKeepWithPrevious

        public boolean mustKeepWithPrevious()
        Convenience method to check if a keep-with-previous constraint is specified.
        Returns:
        true if keep-with-previous is active.

      • getBlockProgressionDimension

        public LengthRangeProperty getBlockProgressionDimension()
        Returns:
        the "block-progression-dimension" property.

      • getHeight

        public Length getHeight()
        Returns:
        the "height" property.

      • getLocalName

        public java.lang.String getLocalName()
        Returns the local name (i.e. without namespace prefix) of the node
        Specified by:
        getLocalName in class FONode
        Returns:
        the local name of this node