pdflayer.html

IText PDF开发工具说明文档,使用很方便。

<A NAME="on"><!-- --></A><H3>
on</H3>
<PRE>
private boolean <B>on</B></PRE>
<DL>
<DD>Holds value of property on.
<P>
<DL>
</DL>
</DL>
<HR>

<A NAME="onPanel"><!-- --></A><H3>
onPanel</H3>
<PRE>
private boolean <B>onPanel</B></PRE>
<DL>
<DD>Holds value of property onPanel.
<P>
<DL>
</DL>
</DL>

<!-- ========= CONSTRUCTOR DETAIL ======== -->

<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>

<A NAME="PdfLayer(java.lang.String)"><!-- --></A><H3>
PdfLayer</H3>
<PRE>
<B>PdfLayer</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;title)</PRE>
<DL>
</DL>
<HR>

<A NAME="PdfLayer(java.lang.String, com.lowagie.text.pdf.PdfWriter)"><!-- --></A><H3>
PdfLayer</H3>
<PRE>
public <B>PdfLayer</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;name,
                <A HREF="../../../../com/lowagie/text/pdf/PdfWriter.html" title="class in com.lowagie.text.pdf">PdfWriter</A>&nbsp;writer)</PRE>
<DL>
<DD>Creates a new layer.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the layer<DD><CODE>writer</CODE> - the writer</DL>
</DL>

<!-- ============ METHOD DETAIL ========== -->

<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>

<A NAME="createTitle(java.lang.String, com.lowagie.text.pdf.PdfWriter)"><!-- --></A><H3>
createTitle</H3>
<PRE>
public static <A HREF="../../../../com/lowagie/text/pdf/PdfLayer.html" title="class in com.lowagie.text.pdf">PdfLayer</A> <B>createTitle</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;title,
                                   <A HREF="../../../../com/lowagie/text/pdf/PdfWriter.html" title="class in com.lowagie.text.pdf">PdfWriter</A>&nbsp;writer)</PRE>
<DL>
<DD>Creates a title layer. A title layer is not really a layer but a collection of layers
 under the same title heading.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>title</CODE> - the title text<DD><CODE>writer</CODE> - the <CODE>PdfWriter</CODE>
<DT><B>Returns:</B><DD>the title layer</DL>
</DD>
</DL>
<HR>

<A NAME="getTitle()"><!-- --></A><H3>
getTitle</H3>
<PRE>
<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getTitle</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="addChild(com.lowagie.text.pdf.PdfLayer)"><!-- --></A><H3>
addChild</H3>
<PRE>
public void <B>addChild</B>(<A HREF="../../../../com/lowagie/text/pdf/PdfLayer.html" title="class in com.lowagie.text.pdf">PdfLayer</A>&nbsp;child)</PRE>
<DL>
<DD>Adds a child layer. Nested layers can only have one parent.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>child</CODE> - the child layer</DL>
</DD>
</DL>
<HR>

<A NAME="getParent()"><!-- --></A><H3>
getParent</H3>
<PRE>
public <A HREF="../../../../com/lowagie/text/pdf/PdfLayer.html" title="class in com.lowagie.text.pdf">PdfLayer</A> <B>getParent</B>()</PRE>
<DL>
<DD>Gets the parent layer.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the parent layer or <CODE>null</CODE> if the layer has no parent</DL>
</DD>
</DL>
<HR>

<A NAME="getChildren()"><!-- --></A><H3>
getChildren</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util">ArrayList</A> <B>getChildren</B>()</PRE>
<DL>
<DD>Gets the children layers.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the children layers or <CODE>null</CODE> if the layer has no children</DL>
</DD>
</DL>
<HR>

<A NAME="getRef()"><!-- --></A><H3>
getRef</H3>
<PRE>
public <A HREF="../../../../com/lowagie/text/pdf/PdfIndirectReference.html" title="class in com.lowagie.text.pdf">PdfIndirectReference</A> <B>getRef</B>()</PRE>
<DL>
<DD>Gets the <CODE>PdfIndirectReference</CODE> that represents this layer.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/lowagie/text/pdf/PdfOCG.html#getRef()">getRef</A></CODE> in interface <CODE><A HREF="../../../../com/lowagie/text/pdf/PdfOCG.html" title="interface in com.lowagie.text.pdf">PdfOCG</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the <CODE>PdfIndirectReference</CODE> that represents this layer</DL>
</DD>
</DL>
<HR>

<A NAME="setRef(com.lowagie.text.pdf.PdfIndirectReference)"><!-- --></A><H3>
setRef</H3>
<PRE>
void <B>setRef</B>(<A HREF="../../../../com/lowagie/text/pdf/PdfIndirectReference.html" title="class in com.lowagie.text.pdf">PdfIndirectReference</A>&nbsp;ref)</PRE>
<DL>
<DD>Sets the <CODE>PdfIndirectReference</CODE> that represents this layer.
 This can only be done from PdfStamperImp.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>ref</CODE> - The reference to the OCG object<DT><B>Since:</B></DT>
  <DD>2.1.2</DD>
</DL>
</DD>
</DL>
<HR>

<A NAME="setName(java.lang.String)"><!-- --></A><H3>
setName</H3>
<PRE>
public void <B>setName</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;name)</PRE>
<DL>
<DD>Sets the name of this layer.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of this layer</DL>
</DD>
</DL>
<HR>

<A NAME="getPdfObject()"><!-- --></A><H3>
getPdfObject</H3>
<PRE>
public <A HREF="../../../../com/lowagie/text/pdf/PdfObject.html" title="class in com.lowagie.text.pdf">PdfObject</A> <B>getPdfObject</B>()</PRE>
<DL>
<DD>Gets the dictionary representing the layer. It just returns <CODE>this</CODE>.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/lowagie/text/pdf/PdfOCG.html#getPdfObject()">getPdfObject</A></CODE> in interface <CODE><A HREF="../../../../com/lowagie/text/pdf/PdfOCG.html" title="interface in com.lowagie.text.pdf">PdfOCG</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the dictionary representing the layer</DL>
</DD>
</DL>
<HR>

<A NAME="isOn()"><!-- --></A><H3>
isOn</H3>
<PRE>
public boolean <B>isOn</B>()</PRE>
<DL>
<DD>Gets the initial visibility of the layer.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the initial visibility of the layer</DL>
</DD>
</DL>
<HR>

<A NAME="setOn(boolean)"><!-- --></A><H3>
setOn</H3>
<PRE>
public void <B>setOn</B>(boolean&nbsp;on)</PRE>
<DL>
<DD>Sets the initial visibility of the layer.
<P>