Section (Aspose.Pdf for Java) - Aspose.Pdf for .NET and Java

Product Suites

Aspose.Total for .NET and Java

Aspose.Total for Reporting Services

File Format Components

Aspose.Words for .NET and Java

Aspose.Cells for .NET and Java

Aspose.Pdf for .NET and Java

Product Information

Programmer's Guide

Knowledge Base

Aspose.Pdf for .Net API Reference

Aspose.Pdf for Java API Reference

com.aspose.pdf

com.aspose.pdf.elements

ActionType (Aspose.Pdf for Java)

AlignmentType (Aspose.Pdf for Java)

AnnotationIconType (Aspose.Pdf for Java)

Arc (Aspose.Pdf for Java)

AsposeXMLReader (Aspose.Pdf for Java)

Attachment (Aspose.Pdf for Java)

AttachmentType (Aspose.Pdf for Java)

BorderInfo (Aspose.Pdf for Java)

BorderSide (Aspose.Pdf for Java)

BorderType (Aspose.Pdf for Java)

Cell (Aspose.Pdf for Java)

Cells (Aspose.Pdf for Java)

Circle (Aspose.Pdf for Java)

CmykColorSpace (Aspose.Pdf for Java)

Color (Aspose.Pdf for Java)

ColumnInfo (Aspose.Pdf for Java)

Curve (Aspose.Pdf for Java)

DestinationType (Aspose.Pdf for Java)

ElementFactory (Aspose.Pdf for Java)

Ellipse (Aspose.Pdf for Java)

FileIconType (Aspose.Pdf for Java)

Graph (Aspose.Pdf for Java)

GraphInfo (Aspose.Pdf for Java)

GrayColorSpace (Aspose.Pdf for Java)

HeaderFooter (Aspose.Pdf for Java)

HeaderFooterType (Aspose.Pdf for Java)

Heading (Aspose.Pdf for Java)

HeadingInfo (Aspose.Pdf for Java)

HeadingType (Aspose.Pdf for Java)

HyperLink (Aspose.Pdf for Java)

HyperLinkToFile (Aspose.Pdf for Java)

HyperLinkToLocalPdf (Aspose.Pdf for Java)

HyperLinkToOuterPdf (Aspose.Pdf for Java)

HyperLinkToWeb (Aspose.Pdf for Java)

Image (Aspose.Pdf for Java)

ImageFileType (Aspose.Pdf for Java)

ImageInfo (Aspose.Pdf for Java)

ImageOpenType (Aspose.Pdf for Java)

JavaScript (Aspose.Pdf for Java)

JavaScripts (Aspose.Pdf for Java)

Line (Aspose.Pdf for Java)

LineStyleType (Aspose.Pdf for Java)

List (Aspose.Pdf for Java)

ListSection (Aspose.Pdf for Java)

MarginInfo (Aspose.Pdf for Java)

OpenType (Aspose.Pdf for Java)

PageSetup (Aspose.Pdf for Java)

PageSize (Aspose.Pdf for Java)

PageTransitionType (Aspose.Pdf for Java)

Paragraph (Aspose.Pdf for Java)

Paragraphs (Aspose.Pdf for Java)

Pdf (Aspose.Pdf for Java)

PdfElementBase (Aspose.Pdf for Java)

Rectangle (Aspose.Pdf for Java)

RectData (Aspose.Pdf for Java)

RenderingMode (Aspose.Pdf for Java)

RgbColorSpace (Aspose.Pdf for Java)

Row (Aspose.Pdf for Java)

Rows (Aspose.Pdf for Java)

Section (Aspose.Pdf for Java)

Sections (Aspose.Pdf for Java)

Security (Aspose.Pdf for Java)

Segment (Aspose.Pdf for Java)

Segments (Aspose.Pdf for Java)

Shape (Aspose.Pdf for Java)

Shapes (Aspose.Pdf for Java)

Table (Aspose.Pdf for Java)

Text (Aspose.Pdf for Java)

TextInfo (Aspose.Pdf for Java)

VerticalAlignmentType (Aspose.Pdf for Java)

VerticalTextRotationType (Aspose.Pdf for Java)

com.aspose.pdf.exception

com.aspose.pdf.utils

Aspose.Slides for .NET and Java

Aspose.Pdf.Kit for .NET and Java

Aspose.Tasks for .NET

Aspose.Form for .NET

Aspose.Metafiles for Java

Aspose.Flash for .NET

Aspose.Recognition for .NET

SSRS Rendering Extensions

Aspose.Words for Reporting Services

Aspose.Slides for Reporting Services

Aspose.Cells for Reporting Services

Aspose.Pdf for Reporting Services

Aspose.BarCode for Reporting Services

JasperReports Exporters

Aspose.Slides for JasperReports

Visual Components

Aspose.BarCode for .NET and Java

Aspose.Grid for .NET

Aspose.Chart for .NET

Aspose.Editor for .NET

Aspose.AdHoc for .NET

Utility Components

Aspose.Network for .NET

Aspose.Workflow for .NET

Aspose.Spell for .NET

Aspose.ASPXpand for .NET

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.aspose.pdf.elements
Class Section

java.lang.Object
  com.aspose.pdf.elements.PdfElementBase
      com.aspose.pdf.elements.Section

All Implemented Interfaces:: java.lang.Cloneable

Direct Known Subclasses:: ListSection

public class Section
extends PdfElementBase
extends PdfElementBase

Represents a section in a Pdf document.

Constructor Summary
`Section(Pdf pdf)` Initializes a new instance of the Section class.

Method Summary
`java.lang.Object`	`clone()` Clone an object.
`Color`	`getBackgroundColor()` Gets a Color object that indicates the background color of the section.
`java.lang.String`	`getBackgroundImageFile()` Gets a string that indicates the background image file name.
`float`	`getBackgroundImageFixedHeight()` Gets a float value that indicates the fixed height of the background image.
`float`	`getBackgroundImageFixedWidth()` Gets a float value that indicates the fixed width of the background image.
`ColumnInfo`	`getColumnInfo()` Gets a ColumnInfo object that indicates the columns info.
`org.w3c.dom.Element`	`getDOMElement()` Gets a DOM representation of the pdf element.
`HeaderFooter`	`getEvenFooter()` Gets a HeaderFooter object that indicates the even footer of the section.
`HeaderFooter`	`getEvenHeader()` Gets a HeaderFooter object that indicates the even header of the section.
`int`	`getFirstLineIndent()` Gets an int value that indicates the blank space at the beginning of the section.
`HeaderFooter`	`getFirstPageFooter()` Gets a HeaderFooter object that indicates the first page footer of the section. If the first page needs one footer style, the subsequent pages need another footer style, the first page footer is needed.
`HeaderFooter`	`getFirstPageHeader()` Gets a HeaderFooter object that indicates the first page header of the section.
`GraphInfo`	`getGraphInfo()` Gets a GraphInfo that indicates graph info of the section.
`HeaderFooter`	`getLastPageFooter()` Gets a HeaderFooter object that indicates the last page footer of the section.
`HeaderFooter`	`getLastPageHeader()` Gets a HeaderFooter object that indicates the lasgt page header of the section.
`HeaderFooter`	`getOddFooter()` Gets a HeaderFooter object that indicates the odd footer of the section.
`HeaderFooter`	`getOddHeader()` Gets a HeaderFooter object that indicates the odd header of the section.
`int`	`getPageRotatingAngle()` Gets the number of degrees by which the page should be rotated clockwise when displayed or printed.
`PageSetup`	`getPageSetup()` Gets a PageSetup that indicates page info of the section.
`Paragraphs`	`getParagraphs()` Gets a Paragraph collection that indicates all paragraphs in the section.
`Pdf`	`getPdf()` Gets the pdf document.
`int`	`getStartingPageNumber()` Gets a int value that indicates the starting page number of the section.
`TextInfo`	`getTextInfo()`
`boolean`	`isBackgroundImageBlackWhite()` Gets a bool value that indicates whether the image is forced to be black-and-white.
`boolean`	`isDisabled()` Gets a bool value that indicates whether this section is disabled.
`boolean`	`isLandscape()` Gets a bool value that indicates whether the page orientation is landscape.
`boolean`	`isNewColumn()` Gets a bool value that indicates whether the section starts at new column.Default is true.
`void`	`isNewColumn(boolean isNewColumn)` Sets a bool value that indicates whether the section starts at new column.Default is true.
`boolean`	`isPageNumberRestarted()` Gets a bool value that indicates whether the page number be restarted at this section.
`void`	`isPageNumberRestarted(boolean pageNumberRestarted)` Sets a bool value that indicates whether the page number be restarted at this section.
`boolean`	`isSpaced()` Gets a bool value that indicates whether the spaces at the begin of the text and returns in the text be shown.
`void`	`setBackgroundColor(Color color)` Sets a Color object that indicates the background color of the section.
`void`	`setBackgroundImageFile(java.lang.String imageFile)` Sets a string that indicates the background image file name.
`void`	`setBackgroundImageFixedHeight(float imageFixedHeight)` Sets a float value that indicates the fixed height of the background image.
`void`	`setBackgroundImageFixedWidth(float imageFixedWidth)` Sets a float value that indicates the fixed width of the background image.
`void`	`setColumnInfo(ColumnInfo info)` Sets a ColumnInfo object that indicates the columns info.
`void`	`setEvenFooter(HeaderFooter footer)` Sets a HeaderFooter object that indicates the even footer of the section.
`void`	`setEvenHeader(HeaderFooter header)` Sets a HeaderFooter object that indicates the even header of the section.
`void`	`setFirstLineIndent(int indent)` Sets an int value that indicates the blank space at the beginning of the section.
`void`	`setFirstPageFooter(HeaderFooter firstPageFooter)` Sets a HeaderFooter object that indicates the first page footer of the section. If the first page needs one footer style, the subsequent pages need another footer style, the first page footer is needed.
`void`	`setFirstPageHeader(HeaderFooter firstPageHeader)` Sets a HeaderFooter object that indicates the first page header of the section.
`void`	`setGraphInfo(GraphInfo graphInfo)` Sets a GraphInfo that indicates graph info of the section.
`void`	`setIsBackgroundImageBlackWhite(boolean backgroundImageBlackWhite)` Sets a bool value that indicates whether the image is forced to be black-and-white.
`void`	`setIsDisabled(boolean disabled)` Sets a bool value that indicates whether this section is disabled.
`void`	`setIsLandscape(boolean landscape)` Sets a bool value that indicates whether the page orientation is landscape.
`void`	`setIsSpaced(boolean isSpaced)` Sets a bool value that indicates whether the spaces at the begin of the text and returns in the text be shown.
`void`	`setLastPageFooter(HeaderFooter lastPageFooter)` Sets a HeaderFooter object that indicates the last page footer of the section.
`void`	`setLastPageHeader(HeaderFooter lastPageHeader)` Sets a HeaderFooter object that indicates the last page header of the section.
`void`	`setOddFooter(HeaderFooter oddFooter)` Sets a HeaderFooter object that indicates the odd footer of the section.
`void`	`setOddHeader(HeaderFooter oddHeader)` Sets a HeaderFooter object that indicates the odd header of the section.
`void`	`setPageRotatingAngle(int rotatingAngle)` Sets the number of degrees by which the page should be rotated clockwise when displayed or printed.
`void`	`setPageSetup(PageSetup pageSetup)` Sets a PageSetup that indicates page info of the section.
`void`	`setParagraphs(Paragraphs paragraphs)` Sets a Paragraph collection that indicates all paragraphs in the section.
`void`	`setStartingPageNumber(int startingPageNumber)` Sets a int value that indicates the starting page number of the section.
`void`	`setTextInfo(TextInfo textInfo)`

Methods inherited from class com.aspose.pdf.elements.PdfElementBase
`getElementFactory, getID, getNameIndex, setID`

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

Section

public Section(Pdf pdf)
        throws AsposeBaseException

Initializes a new instance of the Section class.

Parameters:: pdf - the pdf document that owns the Section.
Throws:: AsposeBaseException

Method Detail

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Description copied from class: PdfElementBase

Clone an object.

Overrides:: clone in class PdfElementBase

Throws:: java.lang.CloneNotSupportedException
See Also:: Object.clone()

getBackgroundColor

public Color getBackgroundColor()

Gets a Color object that indicates the background color of the section.

setBackgroundColor

public void setBackgroundColor(Color color)

Sets a Color object that indicates the background color of the section.

getBackgroundImageFile

public java.lang.String getBackgroundImageFile()

Gets a string that indicates the background image file name.

setBackgroundImageFile

public void setBackgroundImageFile(java.lang.String imageFile)

Sets a string that indicates the background image file name.

getBackgroundImageFixedWidth

public float getBackgroundImageFixedWidth()

Gets a float value that indicates the fixed width of the background image.

setBackgroundImageFixedWidth

public void setBackgroundImageFixedWidth(float imageFixedWidth)

Sets a float value that indicates the fixed width of the background image. If this property is not set, the image size will be the image's real size.

getBackgroundImageFixedHeight

public float getBackgroundImageFixedHeight()

Gets a float value that indicates the fixed height of the background image.

setBackgroundImageFixedHeight

public void setBackgroundImageFixedHeight(float imageFixedHeight)

Sets a float value that indicates the fixed height of the background image. If this property is not set, the image size will be the image's real size.

setPageSetup

public void setPageSetup(PageSetup pageSetup)

Sets a PageSetup that indicates page info of the section.

getPageSetup

public PageSetup getPageSetup()

Gets a PageSetup that indicates page info of the section.

setTextInfo

public void setTextInfo(TextInfo textInfo)

getTextInfo

public TextInfo getTextInfo()

getParagraphs

public Paragraphs getParagraphs()

Gets a Paragraph collection that indicates all paragraphs in the section.

Returns:: Returns the paragraphs collection.

setParagraphs

public void setParagraphs(Paragraphs paragraphs)

Sets a Paragraph collection that indicates all paragraphs in the section.

Parameters:: paragraphs - The paragraphs to set.

getFirstLineIndent

public int getFirstLineIndent()

Gets an int value that indicates the blank space at the beginning of the section.

Returns:: Returns the m_firstLineIndent.

setFirstLineIndent

public void setFirstLineIndent(int indent)

Sets an int value that indicates the blank space at the beginning of the section.

Parameters:: indent - The indent to set.

isSpaced

public boolean isSpaced()

Gets a bool value that indicates whether the spaces at the begin of the text and returns in the text be shown.

 [SampleCode]
 Gets or sets a bool value that indicates whether the spaces at
 the begin of the text and returns in the text be shown. 
 For the following XML: 
       
        The first line,
        The second line.
       
 If IsSpaced is false, the result will be: 
 The first line,The second line.
 If IsSpaced is true, the result will be: 
                                The first line,
                                        The second line.

setIsSpaced

public void setIsSpaced(boolean isSpaced)

Sets a bool value that indicates whether the spaces at the begin of the text and returns in the text be shown.

getGraphInfo

public GraphInfo getGraphInfo()

Gets a GraphInfo that indicates graph info of the section.

com.aspose.pdf.elements Class Section