Java Doc for PdfLayer.java in  » PDF » pdf-itext » com » lowagie » text » pdf » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » PDF » pdf itext » com.lowagie.text.pdf 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   com.lowagie.text.pdf.PdfObject
      com.lowagie.text.pdf.PdfDictionary
         com.lowagie.text.pdf.PdfLayer

PdfLayer
public class PdfLayer extends PdfDictionary implements PdfOCG(Code)
An optional content group is a dictionary representing a collection of graphics that can be made visible or invisible dynamically by users of viewer applications. In iText they are referenced as layers.
author:
   Paulo Soares (psoares@consiste.pt)


Field Summary
protected  ArrayListchildren
    
protected  PdfLayerparent
    
protected  PdfIndirectReferenceref
    
protected  Stringtitle
    

Constructor Summary
 PdfLayer(String title)
    
public  PdfLayer(String name, PdfWriter writer)
     Creates a new layer.

Method Summary
public  voidaddChild(PdfLayer child)
     Adds a child layer.
public static  PdfLayercreateTitle(String title, PdfWriter writer)
     Creates a title layer.
public  ArrayListgetChildren()
     Gets the children layers.
public  PdfLayergetParent()
     Gets the parent layer.
public  PdfObjectgetPdfObject()
     Gets the dictionary representing the layer.
public  PdfIndirectReferencegetRef()
     Gets the PdfIndirectReference that represents this layer.
 StringgetTitle()
    
public  booleanisOn()
     Gets the initial visibility of the layer.
public  booleanisOnPanel()
    
public  voidsetCreatorInfo(String creator, String subtype)
     Used by the creating application to store application-specific data associated with this optional content group.
Parameters:
  creator - a text string specifying the application that created the group
Parameters:
  subtype - a string defining the type of content controlled by the group.
public  voidsetExport(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).
public  voidsetLanguage(String lang, boolean preferred)
    
public  voidsetName(String name)
     Sets the name of this layer.
public  voidsetOn(boolean on)
     Sets the initial visibility of the layer.
public  voidsetOnPanel(boolean onPanel)
     Sets the visibility of the layer in Acrobat's layer panel.
public  voidsetPrint(String subtype, boolean printstate)
    
public  voidsetView(boolean view)
     Indicates that the group should be set to that state when the document is opened in a viewer application.
public  voidsetZoom(float min, float max)
     Specifies a range of magnifications at which the content in this optional content group is best viewed.
Parameters:
  min - the minimum recommended magnification factors at which the groupshould be ON.

Field Detail
children
protected ArrayList children(Code)



parent
protected PdfLayer parent(Code)



ref
protected PdfIndirectReference ref(Code)



title
protected String title(Code)




Constructor Detail
PdfLayer
PdfLayer(String title)(Code)



PdfLayer
public PdfLayer(String name, PdfWriter writer)(Code)
Creates a new layer.
Parameters:
  name - the name of the layer
Parameters:
  writer - the writer




Method Detail
addChild
public void addChild(PdfLayer child)(Code)
Adds a child layer. Nested layers can only have one parent.
Parameters:
  child - the child layer



createTitle
public static PdfLayer createTitle(String title, PdfWriter writer)(Code)
Creates a title layer. A title layer is not really a layer but a collection of layers under the same title heading.
Parameters:
  title - the title text
Parameters:
  writer - the PdfWriter the title layer



getChildren
public ArrayList getChildren()(Code)
Gets the children layers. the children layers or null if the layer has no children



getParent
public PdfLayer getParent()(Code)
Gets the parent layer. the parent layer or null if the layer has no parent



getPdfObject
public PdfObject getPdfObject()(Code)
Gets the dictionary representing the layer. It just returns this. the dictionary representing the layer



getRef
public PdfIndirectReference getRef()(Code)
Gets the PdfIndirectReference that represents this layer. the PdfIndirectReference that represents this layer



getTitle
String getTitle()(Code)



isOn
public boolean isOn()(Code)
Gets the initial visibility of the layer. the initial visibility of the layer



isOnPanel
public boolean isOnPanel()(Code)
Gets the layer visibility in Acrobat's layer panel the layer visibility in Acrobat's layer panel



setCreatorInfo
public void setCreatorInfo(String creator, String subtype)(Code)
Used by the creating application to store application-specific data associated with this optional content group.
Parameters:
  creator - a text string specifying the application that created the group
Parameters:
  subtype - a string defining the type of content controlled by the group. Suggestedvalues include but are not limited to Artwork, for graphic-design or publishingapplications, and Technical, for technical designs such as building plans orschematics



setExport
public void setExport(boolean export)(Code)
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).
Parameters:
  export - the export state



setLanguage
public void setLanguage(String lang, boolean preferred)(Code)
Specifies the language of the content controlled by this optional content group
Parameters:
  lang - a language string which specifies a language and possibly a locale(for example, es-MX represents Mexican Spanish)
Parameters:
  preferred - used by viewer applications when there is a partial match but no exactmatch between the system language and the language strings in all usage dictionaries



setName
public void setName(String name)(Code)
Sets the name of this layer.
Parameters:
  name - the name of this layer



setOn
public void setOn(boolean on)(Code)
Sets the initial visibility of the layer.
Parameters:
  on - the initial visibility of the layer



setOnPanel
public void setOnPanel(boolean onPanel)(Code)
Sets the visibility of the layer in Acrobat's layer panel. If 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



setPrint
public void setPrint(String subtype, boolean printstate)(Code)
Specifies that the content in this group is intended for use in printing
Parameters:
  subtype - a name specifying the kind of content controlled by the group;for example, Trapping, PrintersMarks and Watermark
Parameters:
  printstate - indicates that the group should beset to that state when the document is printed from a viewer application



setView
public void setView(boolean view)(Code)
Indicates that the group should be set to that state when the document is opened in a viewer application.
Parameters:
  view - the view state



setZoom
public void setZoom(float min, float max)(Code)
Specifies a range of magnifications at which the content in this optional content group is best viewed.
Parameters:
  min - the minimum recommended magnification factors at which the groupshould be ON. A negative value will set the default to 0
Parameters:
  max - the maximum recommended magnification factor at which the groupshould be ON. A negative value will set the largest possible magnification supported by theviewer application



Fields inherited from com.lowagie.text.pdf.PdfDictionary
final public static PdfName CATALOG(Code)(Java Doc)
final public static PdfName FONT(Code)(Java Doc)
final public static PdfName OUTLINES(Code)(Java Doc)
final public static PdfName PAGE(Code)(Java Doc)
final public static PdfName PAGES(Code)(Java Doc)
protected HashMap hashMap(Code)(Java Doc)

Methods inherited from com.lowagie.text.pdf.PdfDictionary
public boolean contains(PdfName key)(Code)(Java Doc)
public PdfObject get(PdfName key)(Code)(Java Doc)
public PdfArray getAsArray(PdfName key)(Code)(Java Doc)
public PdfBoolean getAsBoolean(PdfName key)(Code)(Java Doc)
public PdfDictionary getAsDict(PdfName key)(Code)(Java Doc)
public PdfIndirectReference getAsIndirectObject(PdfName key)(Code)(Java Doc)
public PdfName getAsName(PdfName key)(Code)(Java Doc)
public PdfNumber getAsNumber(PdfName key)(Code)(Java Doc)
public PdfStream getAsStream(PdfName key)(Code)(Java Doc)
public PdfString getAsString(PdfName key)(Code)(Java Doc)
public PdfObject getDirectObject(PdfName key)(Code)(Java Doc)
public Set getKeys()(Code)(Java Doc)
public boolean isCatalog()(Code)(Java Doc)
public boolean isDictionaryType(PdfName type)(Code)(Java Doc)
public boolean isFont()(Code)(Java Doc)
public boolean isOutlineTree()(Code)(Java Doc)
public boolean isPage()(Code)(Java Doc)
public boolean isPages()(Code)(Java Doc)
public void merge(PdfDictionary other)(Code)(Java Doc)
public void mergeDifferent(PdfDictionary other)(Code)(Java Doc)
public void put(PdfName key, PdfObject value)(Code)(Java Doc)
public void putAll(PdfDictionary dic)(Code)(Java Doc)
public void putEx(PdfName key, PdfObject value)(Code)(Java Doc)
public void remove(PdfName key)(Code)(Java Doc)
public int size()(Code)(Java Doc)
public void toPdf(PdfWriter writer, OutputStream os) throws IOException(Code)(Java Doc)
public String toString()(Code)(Java Doc)

Fields inherited from com.lowagie.text.pdf.PdfObject
final public static int ARRAY(Code)(Java Doc)
final public static int BOOLEAN(Code)(Java Doc)
final public static int DICTIONARY(Code)(Java Doc)
final public static int INDIRECT(Code)(Java Doc)
final public static int NAME(Code)(Java Doc)
final public static String NOTHING(Code)(Java Doc)
final public static int NULL(Code)(Java Doc)
final public static int NUMBER(Code)(Java Doc)
final public static int STREAM(Code)(Java Doc)
final public static int STRING(Code)(Java Doc)
final public static String TEXT_PDFDOCENCODING(Code)(Java Doc)
final public static String TEXT_UNICODE(Code)(Java Doc)
protected byte[] bytes(Code)(Java Doc)
protected PRIndirectReference indRef(Code)(Java Doc)
protected int type(Code)(Java Doc)

Methods inherited from com.lowagie.text.pdf.PdfObject
public boolean canBeInObjStm()(Code)(Java Doc)
public byte[] getBytes()(Code)(Java Doc)
public PRIndirectReference getIndRef()(Code)(Java Doc)
public boolean isArray()(Code)(Java Doc)
public boolean isBoolean()(Code)(Java Doc)
public boolean isDictionary()(Code)(Java Doc)
public boolean isIndirect()(Code)(Java Doc)
public boolean isName()(Code)(Java Doc)
public boolean isNull()(Code)(Java Doc)
public boolean isNumber()(Code)(Java Doc)
public boolean isStream()(Code)(Java Doc)
public boolean isString()(Code)(Java Doc)
public int length()(Code)(Java Doc)
protected void setContent(String content)(Code)(Java Doc)
public void setIndRef(PRIndirectReference indRef)(Code)(Java Doc)
public void toPdf(PdfWriter writer, OutputStream os) throws IOException(Code)(Java Doc)
public String toString()(Code)(Java Doc)
public int type()(Code)(Java Doc)

Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.