com.lowagie.text.pdf
public class PdfLayer extends PdfDictionary implements PdfOCG
Field Summary | |
---|---|
protected ArrayList | children |
boolean | on
Holds value of property on. |
boolean | onPanel
Holds value of property onPanel. |
protected PdfLayer | parent |
protected PdfIndirectReference | ref |
protected String | title |
Constructor Summary | |
---|---|
PdfLayer(String title) | |
PdfLayer(String name, PdfWriter writer)
Creates a new layer. |
Method Summary | |
---|---|
void | addChild(PdfLayer child)
Adds a child layer. |
static PdfLayer | createTitle(String title, PdfWriter writer)
Creates a title layer. |
ArrayList | getChildren()
Gets the children layers. |
PdfLayer | getParent()
Gets the parent layer. |
PdfObject | getPdfObject()
Gets the dictionary representing the layer. |
PdfIndirectReference | getRef()
Gets the PdfIndirectReference that represents this layer. |
String | getTitle() |
PdfDictionary | getUsage() |
boolean | isOn()
Gets the initial visibility of the layer. |
boolean | isOnPanel()
Gets the layer visibility in Acrobat's layer panel |
void | setCreatorInfo(String creator, String subtype)
Used by the creating application to store application-specific
data associated with this optional content group. |
void | setExport(boolean export)
Specifies the recommended state for content in this
group when the document (or part of it) is saved by a viewer application to a format
that does not support optional content (for example, an earlier version of
PDF or a raster image format). |
void | setLanguage(String lang, boolean preferred)
Specifies the language of the content controlled by this
optional content group |
void | setName(String name)
Sets the name of this layer. |
void | setOn(boolean on)
Sets the initial visibility of the layer. |
void | setOnPanel(boolean onPanel)
Sets the visibility of the layer in Acrobat's layer panel. |
void | setPrint(String subtype, boolean printstate)
Specifies that the content in this group is intended for
use in printing |
void | setRef(PdfIndirectReference ref)
Sets the PdfIndirectReference that represents this layer.
|
void | setView(boolean view)
Indicates that the group should be set to that state when the
document is opened in a viewer application. |
void | setZoom(float min, float max)
Specifies a range of magnifications at which the content
in this optional content group is best viewed. |
Parameters: name the name of the layer writer the writer
Parameters: child the child layer
Parameters: title the title text writer the PdfWriter
Returns: the title layer
Returns: the children layers or null
if the layer has no children
Returns: the parent layer or null
if the layer has no parent
this
.Returns: the dictionary representing the layer
PdfIndirectReference
that represents this layer.Returns: the PdfIndirectReference
that represents this layer
Returns: the initial visibility of the layer
Returns: the layer visibility in Acrobat's layer panel
Parameters: creator a text string specifying the application that created the group subtype a string defining the type of content controlled by the group. Suggested values include but are not limited to Artwork, for graphic-design or publishing applications, and Technical, for technical designs such as building plans or schematics
Parameters: export the export state
Parameters: lang a language string which specifies a language and possibly a locale (for example, es-MX represents Mexican Spanish) preferred used by viewer applications when there is a partial match but no exact match between the system language and the language strings in all usage dictionaries
Parameters: name the name of this layer
Parameters: on the initial visibility of the layer
false
the layer cannot be directly manipulated by the user. Note that any children layers will
also be absent from the panel.Parameters: onPanel the visibility of the layer in Acrobat's layer panel
Parameters: subtype a name specifying the kind of content controlled by the group; for example, Trapping, PrintersMarks and Watermark printstate indicates that the group should be set to that state when the document is printed from a viewer application
PdfIndirectReference
that represents this layer.
This can only be done from PdfStamperImp.Parameters: ref The reference to the OCG object
Since: 2.1.2
Parameters: view the view state
Parameters: min the minimum recommended magnification factors at which the group should be ON. A negative value will set the default to 0 max the maximum recommended magnification factor at which the group should be ON. A negative value will set the largest possible magnification supported by the viewer application