Java Doc for PdfOutline.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

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL 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 .PdfOutline

PdfOutline
public class PdfOutline extends PdfDictionary (Code)
	`PdfOutline` is an object that represents a PDF outline entry. An outline allows a user to access views of a document by name. This object is described in the 'Portable Document Format Reference Manual version 1.3' section 6.7 (page 104-106) See Also: PdfDictionary

Field Summary
protected ArrayList	kids
protected PdfWriter	writer

Constructor Summary
	PdfOutline(PdfWriter writer) Constructs a `PdfOutline`.
public	PdfOutline(PdfOutline parent, PdfAction action, String title) Constructs a `PdfOutline`. This is the constructor for an `outline entry`.
public	PdfOutline(PdfOutline parent, PdfAction action, String title, boolean open) Constructs a `PdfOutline`.
public	PdfOutline(PdfOutline parent, PdfDestination destination, String title) Constructs a `PdfOutline`. This is the constructor for an `outline entry`.
public	PdfOutline(PdfOutline parent, PdfDestination destination, String title, boolean open) Constructs a `PdfOutline`.
public	PdfOutline(PdfOutline parent, PdfAction action, PdfString title) Constructs a `PdfOutline`. This is the constructor for an `outline entry`.
public	PdfOutline(PdfOutline parent, PdfAction action, PdfString title, boolean open) Constructs a `PdfOutline`.
public	PdfOutline(PdfOutline parent, PdfDestination destination, PdfString title) Constructs a `PdfOutline`. This is the constructor for an `outline entry`.
public	PdfOutline(PdfOutline parent, PdfDestination destination, PdfString title, boolean open) Constructs a `PdfOutline`.
public	PdfOutline(PdfOutline parent, PdfAction action, Paragraph title) Constructs a `PdfOutline`. This is the constructor for an `outline entry`.
public	PdfOutline(PdfOutline parent, PdfAction action, Paragraph title, boolean open) Constructs a `PdfOutline`.
public	PdfOutline(PdfOutline parent, PdfDestination destination, Paragraph title) Constructs a `PdfOutline`. This is the constructor for an `outline entry`.
public	PdfOutline(PdfOutline parent, PdfDestination destination, Paragraph title, boolean open) Constructs a `PdfOutline`.

Method Summary
public void	addKid(PdfOutline outline)
public Color	getColor() Getter for property color.
int	getCount()
public ArrayList	getKids()
public PdfDestination	getPdfDestination() Gets the destination for this outline.
public int	getStyle() Getter for property style.
public String	getTag() Getter for property tag.
public String	getTitle()
public PdfIndirectReference	indirectReference() Gets the indirect reference of this `PdfOutline`.
void	initOutline(PdfOutline parent, String title, boolean open) Helper for the constructors.
public boolean	isOpen() Getter for property open.
public int	level() returns the level of this outline.
public PdfOutline	parent() Gets the parent of this `PdfOutline`.
public void	setColor(Color color) Setter for property color.
void	setCount(int count)
public boolean	setDestinationPage(PdfIndirectReference pageReference) Set the page of the `PdfDestination`-object.
public void	setIndirectReference(PdfIndirectReference reference) Sets the indirect reference of this `PdfOutline`.
public void	setKids(ArrayList kids)
public void	setOpen(boolean open) Setter for property open.
public void	setStyle(int style) Setter for property style.
public void	setTag(String tag) Setter for property tag.
public void	setTitle(String title)
public void	toPdf(PdfWriter writer, OutputStream os) Returns the PDF representation of this `PdfOutline`.

Field Detail

kids
protected ArrayList kids(Code)

writer
protected PdfWriter writer(Code)

Constructor Detail

PdfOutline
PdfOutline(PdfWriter writer)(Code)
	Constructs a `PdfOutline`. This is the constructor for the `outlines object`. Parameters: writer - The PdfWriter you are adding the outline to

PdfOutline
public PdfOutline(PdfOutline parent, PdfAction action, String title)(Code)
	Constructs a `PdfOutline`. This is the constructor for an `outline entry`. The open mode is `true`. Parameters: parent - the parent of this outline item Parameters: action - the `PdfAction` for this outline item Parameters: title - the title of this outline item

PdfOutline
public PdfOutline(PdfOutline parent, PdfAction action, String title, boolean open)(Code)
	Constructs a `PdfOutline`. This is the constructor for an `outline entry`. Parameters: parent - the parent of this outline item Parameters: action - the `PdfAction` for this outline item Parameters: title - the title of this outline item Parameters: open - `true` if the children are visible

PdfOutline
public PdfOutline(PdfOutline parent, PdfDestination destination, String title)(Code)
	Constructs a `PdfOutline`. This is the constructor for an `outline entry`. The open mode is `true`. Parameters: parent - the parent of this outline item Parameters: destination - the destination for this outline item Parameters: title - the title of this outline item

PdfOutline
public PdfOutline(PdfOutline parent, PdfDestination destination, String title, boolean open)(Code)
	Constructs a `PdfOutline`. This is the constructor for an `outline entry`. Parameters: parent - the parent of this outline item Parameters: destination - the destination for this outline item Parameters: title - the title of this outline item Parameters: open - `true` if the children are visible

PdfOutline
public PdfOutline(PdfOutline parent, PdfAction action, PdfString title)(Code)
	Constructs a `PdfOutline`. This is the constructor for an `outline entry`. The open mode is `true`. Parameters: parent - the parent of this outline item Parameters: action - the `PdfAction` for this outline item Parameters: title - the title of this outline item

PdfOutline
public PdfOutline(PdfOutline parent, PdfAction action, PdfString title, boolean open)(Code)
	Constructs a `PdfOutline`. This is the constructor for an `outline entry`. Parameters: parent - the parent of this outline item Parameters: action - the `PdfAction` for this outline item Parameters: title - the title of this outline item Parameters: open - `true` if the children are visible

PdfOutline
public PdfOutline(PdfOutline parent, PdfDestination destination, PdfString title)(Code)
	Constructs a `PdfOutline`. This is the constructor for an `outline entry`. The open mode is `true`. Parameters: parent - the parent of this outline item Parameters: destination - the destination for this outline item Parameters: title - the title of this outline item

PdfOutline
public PdfOutline(PdfOutline parent, PdfDestination destination, PdfString title, boolean open)(Code)
	Constructs a `PdfOutline`. This is the constructor for an `outline entry`. Parameters: parent - the parent of this outline item Parameters: destination - the destination for this outline item Parameters: title - the title of this outline item Parameters: open - `true` if the children are visible

PdfOutline
public PdfOutline(PdfOutline parent, PdfAction action, Paragraph title)(Code)
	Constructs a `PdfOutline`. This is the constructor for an `outline entry`. The open mode is `true`. Parameters: parent - the parent of this outline item Parameters: action - the `PdfAction` for this outline item Parameters: title - the title of this outline item

PdfOutline
public PdfOutline(PdfOutline parent, PdfAction action, Paragraph title, boolean open)(Code)
	Constructs a `PdfOutline`. This is the constructor for an `outline entry`. Parameters: parent - the parent of this outline item Parameters: action - the `PdfAction` for this outline item Parameters: title - the title of this outline item Parameters: open - `true` if the children are visible

PdfOutline
public PdfOutline(PdfOutline parent, PdfDestination destination, Paragraph title)(Code)
	Constructs a `PdfOutline`. This is the constructor for an `outline entry`. The open mode is `true`. Parameters: parent - the parent of this outline item Parameters: destination - the destination for this outline item Parameters: title - the title of this outline item

PdfOutline
public PdfOutline(PdfOutline parent, PdfDestination destination, Paragraph title, boolean open)(Code)
	Constructs a `PdfOutline`. This is the constructor for an `outline entry`. Parameters: parent - the parent of this outline item Parameters: destination - the destination for this outline item Parameters: title - the title of this outline item Parameters: open - `true` if the children are visible

Method Detail

addKid
public void addKid(PdfOutline outline)(Code)
	Adds a kid to the outline Parameters: outline -

getColor
public Color getColor()(Code)
	Getter for property color. Value of property color.

getCount
int getCount()(Code)

getKids
public ArrayList getKids()(Code)
	Returns the kids of this outline an ArrayList with PdfOutlines

getPdfDestination
public PdfDestination getPdfDestination()(Code)
	Gets the destination for this outline. the destination

getStyle
public int getStyle()(Code)
	Getter for property style. Value of property style.

getTag
public String getTag()(Code)
	Getter for property tag. Value of property tag.

getTitle
public String getTitle()(Code)
	Gets the title of this outline the title as a String

indirectReference
public PdfIndirectReference indirectReference()(Code)
	Gets the indirect reference of this `PdfOutline`. the `PdfIndirectReference` to this outline.

initOutline
void initOutline(PdfOutline parent, String title, boolean open)(Code)
	Helper for the constructors. Parameters: parent - the parent outline Parameters: title - the title for this outline Parameters: open - `true` if the children are visible

isOpen
public boolean isOpen()(Code)
	Getter for property open. Value of property open.

level
public int level()(Code)
	returns the level of this outline. a level

parent
public PdfOutline parent()(Code)
	Gets the parent of this `PdfOutline`. the `PdfOutline` that is the parent of this outline.

setColor
public void setColor(Color color)(Code)
	Setter for property color. Parameters: color - New value of property color.

setCount
void setCount(int count)(Code)

setDestinationPage
public boolean setDestinationPage(PdfIndirectReference pageReference)(Code)
	Set the page of the `PdfDestination`-object. Parameters: pageReference - indirect reference to the page `true` if this page was set as the `PdfDestination`-page.

setIndirectReference
public void setIndirectReference(PdfIndirectReference reference)(Code)
	Sets the indirect reference of this `PdfOutline`. Parameters: reference - the `PdfIndirectReference` to this outline.

setKids
public void setKids(ArrayList kids)(Code)
	Sets the kids of this outline Parameters: kids -

setOpen
public void setOpen(boolean open)(Code)
	Setter for property open. Parameters: open - New value of property open.

setStyle
public void setStyle(int style)(Code)
	Setter for property style. Parameters: style - New value of property style.

setTag
public void setTag(String tag)(Code)
	Setter for property tag. Parameters: tag - New value of property tag.

setTitle
public void setTitle(String title)(Code)
	Sets the title of this outline Parameters: title -

toPdf
public void toPdf(PdfWriter writer, OutputStream os) throws IOException(Code)
	Returns the PDF representation of this `PdfOutline`. Parameters: writer - the encryption information Parameters: os - throws: IOException -

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

All other trademarks are property of their respective owners.