trait PlayFop extends AnyRef
The primary entry point into PlayFOP for Scala applications.
- Alphabetic
- By Inheritance
- PlayFop
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Abstract Value Members
-
abstract
def
newFop[U](outputFormat: String, output: OutputStream, autoDetectFontsForPDF: Boolean = false, foUserAgentBlock: (FOUserAgent) ⇒ U = _: FOUserAgent =>): Fop
Creates a new
Fop
instance, optionally auto-detecting fonts (for PDF output) and/or applying a code block to theFOUserAgent
.Creates a new
Fop
instance, optionally auto-detecting fonts (for PDF output) and/or applying a code block to theFOUserAgent
. Sets up theFop
to save output to the suppliedOutputStream
in the supplied format.Note: This method is offered primarily for client code to interrogate the Apache FOP environment (for example, to determine available fonts). Code wishing to process XSL-FO with Apache FOP should rely on a
process...
method instead.- U
the return type of
foUserAgentBlock
(typically inferred, as opposed to explicitly specified)- outputFormat
the format the
Fop
should generate- output
the
OutputStream
to which theFop
should save output- autoDetectFontsForPDF
whether to auto-detect fonts
- foUserAgentBlock
the code block for the
Fop
'sFOUserAgent
- returns
the
Fop
-
abstract
def
processScalaXml[U](xslfo: Node, outputFormat: String, autoDetectFontsForPDF: Boolean = false, foUserAgentBlock: (FOUserAgent) ⇒ U = _: FOUserAgent =>): Array[Byte]
Processes XSL-FO provided as a scala-xml
Node
.Processes XSL-FO provided as a scala-xml
Node
. Optionally auto-detects fonts (for PDF output) and/or applies a code block to theFOUserAgent
. Generates output in the specified format.- U
the return type of
foUserAgentBlock
(typically inferred, as opposed to explicitly specified)- xslfo
the XSL-FO to process
- outputFormat
the format to generate
- autoDetectFontsForPDF
whether to auto-detect fonts
- foUserAgentBlock
the code block for the
FOUserAgent
- returns
the Apache FOP output
-
abstract
def
processStringXml[U](xslfo: String, outputFormat: String, autoDetectFontsForPDF: Boolean = false, foUserAgentBlock: (FOUserAgent) ⇒ U = _: FOUserAgent =>): Array[Byte]
Processes XSL-FO provided as a
String
of XML.Processes XSL-FO provided as a
String
of XML. Optionally auto-detects fonts (for PDF output) and/or applies a code block to theFOUserAgent
. Generates output in the specified format.- U
the return type of
foUserAgentBlock
(typically inferred, as opposed to explicitly specified)- xslfo
the XSL-FO to process
- outputFormat
the format to generate
- autoDetectFontsForPDF
whether to auto-detect fonts
- foUserAgentBlock
the code block for the
FOUserAgent
- returns
the Apache FOP output
-
abstract
def
processTwirlXml[U](xslfo: Xml, outputFormat: String, autoDetectFontsForPDF: Boolean = false, foUserAgentBlock: (FOUserAgent) ⇒ U = _: FOUserAgent =>): Array[Byte]
Processes XSL-FO generated from a Twirl XML template.
Processes XSL-FO generated from a Twirl XML template. Optionally auto-detects fonts (for PDF output) and/or applies a code block to the
FOUserAgent
. Generates output in the specified format.- U
the return type of
foUserAgentBlock
(typically inferred, as opposed to explicitly specified)- xslfo
the XSL-FO to process
- outputFormat
the format to generate
- autoDetectFontsForPDF
whether to auto-detect fonts
- foUserAgentBlock
the code block for the
FOUserAgent
- returns
the Apache FOP output
Concrete Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
Click here to explore the PlayFOP Scaladoc.