Package org.apache.fop.pdf

Class PDFGState

java.lang.Object
org.apache.fop.pdf.PDFObject
org.apache.fop.pdf.PDFGState
All Implemented Interfaces:
PDFWritable
public class PDFGState extends PDFObject
Class representing a /ExtGState object.

  • Field Details

  • Constructor Details

    • PDFGState

      public PDFGState()

  • Method Details

    • getName

      public String getName()
      Returns the name of this object
      Returns:
      the name

    • setAlpha

      public void setAlpha(float val, boolean fill)
      Sets the alpha value.
      Parameters:
      val - alpha value (0.0 - 1.0)
      fill - True if alpha should be set for non-stroking operations, False if for stroking operations

    • addValues

      public void addValues(PDFGState state)
      Adds all values from another GState object to this one.
      Parameters:
      state - source object to copy from

    • addValues

      public void addValues(Map vals)
      Adds all values from a Map to this object.
      Parameters:
      vals - source object to copy from

    • toPDFString

      public String toPDFString()
      This method returns a String representation of the PDF object. The result is normally converted/encoded to a byte array by toPDF(). Only use this method to implement the serialization if the object can be fully represented as text. If the PDF representation of the object contains binary content use toPDF() or output(OutputStream) instead. This applies to any object potentially containing a string object because string object are encrypted and therefore need to be binary.
      Overrides:
      toPDFString in class PDFObject
      Returns:
      String the String representation

    • contentEquals

      protected boolean contentEquals(PDFObject obj)
      Check if the other PDFObject has the same content as the current object.

      Note: This function has a contract which is less binding than Object.equals(Object). Whereas equals would require all values to be identical, this method is not required to check everything. In the case of PDFObjects, this means that the overriding function does not have to check for PDFObject.getObjectID().

      Overrides:
      contentEquals in class PDFObject
      Parameters:
      obj - object to compare to.
      Returns:
      true if the other object has the same content.