Package org.apache.fop.fo.flow

Class Block

    • Constructor Detail

      • Block

        public Block​(FONode parent)
        Base constructor
        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 FObj
        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
        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 FObjMixed
        Throws:
        FOPException - FOP Exception

      • getHyphenationLadderCount

        public Numeric getHyphenationLadderCount()
        Returns:
        the "hyphenation-ladder-count" trait.

      • getKeepWithNext

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

      • getKeepWithPrevious

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

      • getKeepTogether

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

      • getOrphans

        public int getOrphans()
        Returns:
        the "orphans" trait.

      • getWidows

        public int getWidows()
        Returns:
        the "widows" trait.

      • getLineStackingStrategy

        public int getLineStackingStrategy()
        Returns:
        the "line-stacking-strategy" trait.

      • getColor

        public java.awt.Color getColor()
        Returns:
        the "color" trait

      • getLineHeight

        public SpaceProperty getLineHeight()
        Returns:
        the "line-height" trait

      • getSpan

        public int getSpan()
        Returns:
        the "span" trait

      • getTextAlign

        public int getTextAlign()
        Returns:
        the "text-align" trait

      • getTextAlignLast

        public int getTextAlignLast()
        Returns:
        the "text-align-last" trait

      • getTextIndent

        public Length getTextIndent()
        Returns:
        the "text-indent" trait

      • getLastLineEndIndent

        public Length getLastLineEndIndent()
        Returns:
        the "last-line-end-indent" trait

      • getWrapOption

        public int getWrapOption()
        Returns:
        the "wrap-option" trait

      • 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.
        XSL Content Model: marker* initial-property-set? (#PCDATA|%inline;|%block;)*
        Additionally: "An fo:bidi-override that is a descendant of an fo:leader or of the fo:inline child of an fo:footnote may not have block-level children, unless it has a nearer ancestor that is an fo:inline-container."
        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

      • getLinefeedTreatment

        public int getLinefeedTreatment()
        Returns:
        the "linefeed-treatment" trait

      • getWhitespaceTreatment

        public int getWhitespaceTreatment()
        Returns:
        the "white-space-treatment" trait

      • getWhitespaceCollapse

        public int getWhitespaceCollapse()
        Returns:
        the "white-space-collapse" trait

      • getHyphenationKeep

        public int getHyphenationKeep()
        Returns:
        the "hyphenation-keep" trait

      • getIntrusionDisplace

        public int getIntrusionDisplace()
        Returns:
        the "intrusion-displace" trait

      • getLineHeightShiftAdjustment

        public int getLineHeightShiftAdjustment()
        Returns:
        the "line-height-shift-adjustment" trait

      • 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

      • getVisibility

        public int getVisibility()