Interface RenderingContext

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.Object getHint​(java.lang.Object key)
      Returns a hint identified by a key.
      java.util.Map getHints()
      Returns an unmodifiable representation of all hints.
      java.lang.String getMimeType()
      Returns the MIME type associated with the current output format.
      FOUserAgent getUserAgent()
      Returns the user agent.
      void putHint​(java.lang.Object key, java.lang.Object value)
      Sets an additional hint, overriding an existing hint.
      void putHints​(java.util.Map additionalHints)
      Adds additional hints to the existing hints, overriding existing hints.
    • Method Detail

      • getMimeType

        java.lang.String getMimeType()
        Returns the MIME type associated with the current output format.
        Returns:
        the MIME type (ex. application/pdf)
      • getUserAgent

        FOUserAgent getUserAgent()
        Returns the user agent. The user agent is used to access configuration and other information for the rendering process.
        Returns:
        the user agent
      • putHints

        void putHints​(java.util.Map additionalHints)
        Adds additional hints to the existing hints, overriding existing hints.
        Parameters:
        additionalHints - a map of additional hints
      • putHint

        void putHint​(java.lang.Object key,
                     java.lang.Object value)
        Sets an additional hint, overriding an existing hint.
        Parameters:
        key - the key
        value - the value
      • getHints

        java.util.Map getHints()
        Returns an unmodifiable representation of all hints.
        Returns:
        the hints
      • getHint

        java.lang.Object getHint​(java.lang.Object key)
        Returns a hint identified by a key.
        Parameters:
        key - the key
        Returns:
        the hint or null if no hint with the given key could be found