Package org.apache.fop.area

Class Trait.Background

  • All Implemented Interfaces:
    java.io.Serializable
    Enclosing class:
    Trait
    public static class Trait.Background
extends java.lang.Object
implements java.io.Serializable
    Background trait structure. Used for storing back trait information which are related.
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.awt.Color color
      The background color if any.
      private int horiz
      Background horizontal offset for images.
      private org.apache.xmlgraphics.image.loader.ImageInfo imageInfo
      The background image if any.
      private int imageTargetHeight  
      private int imageTargetWidth  
      private int repeat
      Background repeat enum for images.
      private static long serialVersionUID  
      private java.lang.String url
      The background image url if any.
      private int vertical
      Background vertical offset for images.

    • Constructor Summary

      Constructors 
      Constructor Description
      Background()  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.awt.Color getColor()
      Returns the background color.
      private static int getConstantForRepeat​(java.lang.String repeat)  
      int getHoriz()
      Returns the horizontal offset for images.
      org.apache.xmlgraphics.image.loader.ImageInfo getImageInfo()
      Returns the ImageInfo object representing the background image
      int getImageTargetHeight()  
      int getImageTargetWidth()  
      int getRepeat()
      Returns the image repetition behaviour for images.
      private java.lang.String getRepeatString()  
      java.lang.String getURL()
      Returns the URL to the background image
      int getVertical()
      Returns the vertical offset for images.
      void setColor​(java.awt.Color color)
      Sets the color.
      void setHoriz​(int horiz)
      Sets the horizontal offset.
      void setImageInfo​(org.apache.xmlgraphics.image.loader.ImageInfo info)
      Sets the ImageInfo of the image to use as the background image.
      void setImageTargetHeight​(int value)  
      void setImageTargetWidth​(int value)  
      void setRepeat​(int repeat)
      Sets the image repetition behaviour for images.
      void setRepeat​(java.lang.String repeat)
      Sets the image repetition behaviour for images.
      void setURL​(java.lang.String url)
      Sets the URL to the background image.
      void setVertical​(int vertical)
      Sets the vertical offset for images.
      java.lang.String toString()
      Return the string for debugging.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Field Detail

      • color

        private java.awt.Color color
        The background color if any.

      • url

        private java.lang.String url
        The background image url if any.

      • imageInfo

        private org.apache.xmlgraphics.image.loader.ImageInfo imageInfo
        The background image if any.

      • repeat

        private int repeat
        Background repeat enum for images.

      • horiz

        private int horiz
        Background horizontal offset for images.

      • vertical

        private int vertical
        Background vertical offset for images.

      • imageTargetWidth

        private int imageTargetWidth

      • imageTargetHeight

        private int imageTargetHeight

    • Constructor Detail

      • Background

        public Background()

    • Method Detail

      • getColor

        public java.awt.Color getColor()
        Returns the background color.
        Returns:
        background color, null if n/a

      • getHoriz

        public int getHoriz()
        Returns the horizontal offset for images.
        Returns:
        the horizontal offset

      • getRepeat

        public int getRepeat()
        Returns the image repetition behaviour for images.
        Returns:
        the image repetition behaviour

      • getURL

        public java.lang.String getURL()
        Returns the URL to the background image
        Returns:
        URL to the background image, null if n/a

      • getImageInfo

        public org.apache.xmlgraphics.image.loader.ImageInfo getImageInfo()
        Returns the ImageInfo object representing the background image
        Returns:
        the background image, null if n/a

      • getVertical

        public int getVertical()
        Returns the vertical offset for images.
        Returns:
        the vertical offset

      • setColor

        public void setColor​(java.awt.Color color)
        Sets the color.
        Parameters:
        color - The color to set

      • setHoriz

        public void setHoriz​(int horiz)
        Sets the horizontal offset.
        Parameters:
        horiz - The horizontal offset to set

      • setRepeat

        public void setRepeat​(int repeat)
        Sets the image repetition behaviour for images.
        Parameters:
        repeat - The image repetition behaviour to set

      • setRepeat

        public void setRepeat​(java.lang.String repeat)
        Sets the image repetition behaviour for images.
        Parameters:
        repeat - The image repetition behaviour to set

      • setURL

        public void setURL​(java.lang.String url)
        Sets the URL to the background image.
        Parameters:
        url - The URL to set

      • setImageInfo

        public void setImageInfo​(org.apache.xmlgraphics.image.loader.ImageInfo info)
        Sets the ImageInfo of the image to use as the background image.
        Parameters:
        info - The background image's info object

      • setVertical

        public void setVertical​(int vertical)
        Sets the vertical offset for images.
        Parameters:
        vertical - The vertical offset to set

      • getRepeatString

        private java.lang.String getRepeatString()

      • getConstantForRepeat

        private static int getConstantForRepeat​(java.lang.String repeat)

      • toString

        public java.lang.String toString()
        Return the string for debugging.
        Overrides:
        toString in class java.lang.Object

      • setImageTargetWidth

        public void setImageTargetWidth​(int value)

      • getImageTargetWidth

        public int getImageTargetWidth()

      • setImageTargetHeight

        public void setImageTargetHeight​(int value)

      • getImageTargetHeight

        public int getImageTargetHeight()