Package com.groupdocs.cloud.merger.model

Class JoinItem

java.lang.Object

com.groupdocs.cloud.merger.model.JoinItem

public class JoinItem
extends Object

Describes document for join operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JoinItem.ImageJoinModeEnum	Possible modes for the image joining.
static class	JoinItem.RangeModeEnum	Range mode.
static class	JoinItem.WordJoinComplianceEnum	Compliance mode for the Word Ooxml format
static class	JoinItem.WordJoinModeEnum	Allows to join word documents without empty space between documents.

Constructor Summary

Constructors

Constructor	Description
JoinItem()

Method Summary

Modifier and Type	Method	Description
JoinItem	addPagesItem(Integer pagesItem)
JoinItem	endPageNumber(Integer endPageNumber)
boolean	equals(Object o)
JoinItem	fileInfo(FileInfo fileInfo)
Integer	getEndPageNumber()	End page number.
FileInfo	getFileInfo()	File info.
JoinItem.ImageJoinModeEnum	getImageJoinMode()	Possible modes for the image joining.
List<Integer>	getPages()	List of page numbers to use in a Join operation.
JoinItem.RangeModeEnum	getRangeMode()	Range mode.
Integer	getStartPageNumber()	Start page number.
JoinItem.WordJoinComplianceEnum	getWordJoinCompliance()	Compliance mode for the Word Ooxml format
JoinItem.WordJoinModeEnum	getWordJoinMode()	Allows to join word documents without empty space between documents.
int	hashCode()
JoinItem	imageJoinMode(JoinItem.ImageJoinModeEnum imageJoinMode)
JoinItem	pages(List<Integer> pages)
JoinItem	rangeMode(JoinItem.RangeModeEnum rangeMode)
void	setEndPageNumber(Integer endPageNumber)
void	setFileInfo(FileInfo fileInfo)
void	setImageJoinMode(JoinItem.ImageJoinModeEnum imageJoinMode)
void	setPages(List<Integer> pages)
void	setRangeMode(JoinItem.RangeModeEnum rangeMode)
void	setStartPageNumber(Integer startPageNumber)
void	setWordJoinCompliance(JoinItem.WordJoinComplianceEnum wordJoinCompliance)
void	setWordJoinMode(JoinItem.WordJoinModeEnum wordJoinMode)
JoinItem	startPageNumber(Integer startPageNumber)
String	toString()
JoinItem	wordJoinCompliance(JoinItem.WordJoinComplianceEnum wordJoinCompliance)
JoinItem	wordJoinMode(JoinItem.WordJoinModeEnum wordJoinMode)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

JoinItem

public JoinItem()

Method Detail

fileInfo

public JoinItem fileInfo(FileInfo fileInfo)

getFileInfo

public FileInfo getFileInfo()

File info.

Returns:

fileInfo

setFileInfo

public void setFileInfo(FileInfo fileInfo)

pages

public JoinItem pages(List<Integer> pages)

addPagesItem

public JoinItem addPagesItem(Integer pagesItem)

getPages

public List<Integer> getPages()

List of page numbers to use in a Join operation. NOTE: page numbering starts from 1.

Returns:

pages

setPages

public void setPages(List<Integer> pages)

startPageNumber

public JoinItem startPageNumber(Integer startPageNumber)

getStartPageNumber

public Integer getStartPageNumber()

Start page number. Ignored if Pages collection is not empty.

Returns:

startPageNumber

setStartPageNumber

public void setStartPageNumber(Integer startPageNumber)

endPageNumber

public JoinItem endPageNumber(Integer endPageNumber)

getEndPageNumber

public Integer getEndPageNumber()

End page number. Ignored if Pages collection is not empty.

Returns:

endPageNumber

setEndPageNumber

public void setEndPageNumber(Integer endPageNumber)

rangeMode

public JoinItem rangeMode(JoinItem.RangeModeEnum rangeMode)

getRangeMode

public JoinItem.RangeModeEnum getRangeMode()

Range mode. Ignored if Pages collection is not empty. Default value is AllPages.

Returns:

rangeMode

setRangeMode

public void setRangeMode(JoinItem.RangeModeEnum rangeMode)

wordJoinMode

public JoinItem wordJoinMode(JoinItem.WordJoinModeEnum wordJoinMode)

getWordJoinMode

public JoinItem.WordJoinModeEnum getWordJoinMode()

Allows to join word documents without empty space between documents.

Returns:

wordJoinMode

setWordJoinMode

public void setWordJoinMode(JoinItem.WordJoinModeEnum wordJoinMode)

wordJoinCompliance

public JoinItem wordJoinCompliance(JoinItem.WordJoinComplianceEnum wordJoinCompliance)

getWordJoinCompliance

public JoinItem.WordJoinComplianceEnum getWordJoinCompliance()

Compliance mode for the Word Ooxml format

Returns:

wordJoinCompliance

setWordJoinCompliance

public void setWordJoinCompliance(JoinItem.WordJoinComplianceEnum wordJoinCompliance)

imageJoinMode

public JoinItem imageJoinMode(JoinItem.ImageJoinModeEnum imageJoinMode)

getImageJoinMode

public JoinItem.ImageJoinModeEnum getImageJoinMode()

Possible modes for the image joining.

Returns:

imageJoinMode

setImageJoinMode

public void setImageJoinMode(JoinItem.ImageJoinModeEnum imageJoinMode)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object