Skip navigation links

oracle.imaging
Class PageChange

java.lang.Object
oracle.imaging.PageChange

public class PageChange

extends java.lang.Object

Class for objects that describe changes to a document page sequence. ChangeType enum is used to set the type of change represented. If changeType is DeletePage, then currentPageNumber holds the page being deleted, newPageNumber is ignored. If changeType is MovePage, then currentPageNumber is moved to newPageNumber position. If changeType is AppendPage, currentPageNumber and newPageNumber are ignored. If changeType is InsertPage, newPageNumber is the location to which the new document pages are inserted. newPageNumber will become the first page of the new document and all existing pages of the original document will be moved to make room for the pages being inserted.

Nested Class Summary

static class

PageChange.ChangeType

Field Summary

protected PageChange.ChangeType	changeType
protected int	currentPageNumber
protected int	newPageNumber
protected java.lang.String	uploadToken

Constructor Summary

PageChange()

PageChange(PageChange.ChangeType changeType)
Constructs a PageChange object specifying the type of change being made

Method Summary

PageChange.ChangeType	getChangeType() Gets the type of change represented
int	getCurrentPageNumber() Gets the value of the page number being changed
int	getNewPageNumber() Gets the value of the new page number field
java.lang.String	getUploadToken() Gets the uploadToken value
void	setChangeType(PageChange.ChangeType changeType) Sets the type of change operation being represented
void	setCurrentPageNumber(int currentPageNumber) Sets the number of the page being change
void	setNewPageNumber(int newPageNumber) For MovePage ChangeTypes only.
void	setUploadToken(java.lang.String uploadToken) Sets the uploadToken field to reference an uploaded document to be inserted or appended.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

changeType

protected PageChange.ChangeType changeType

uploadToken

protected java.lang.String uploadToken

currentPageNumber

protected int currentPageNumber

newPageNumber

protected int newPageNumber

Constructor Detail

PageChange

public PageChange(PageChange.ChangeType changeType)

Constructs a PageChange object specifying the type of change being made

Parameters:

changeType - a ChangeType value indicating the type of page change operation

PageChange

public PageChange()

Method Detail

setChangeType

public void setChangeType(PageChange.ChangeType changeType)

Sets the type of change operation being represented

Parameters:

changeType - a ChangeType value

getChangeType

public PageChange.ChangeType getChangeType()

Gets the type of change represented

Returns:

a ChangeType value

setUploadToken

public void setUploadToken(java.lang.String uploadToken)

Sets the uploadToken field to reference an uploaded document to be inserted or appended.

Parameters:

uploadToken - a token returned from uploadDocument()

getUploadToken

public java.lang.String getUploadToken()

Gets the uploadToken value

Returns:

the uploadToken value previously set

setCurrentPageNumber

public void setCurrentPageNumber(int currentPageNumber)

Sets the number of the page being change

Parameters:

currentPageNumber - an integer representing the page to be changed

getCurrentPageNumber

public int getCurrentPageNumber()

Gets the value of the page number being changed

Returns:

an integer value

setNewPageNumber

public void setNewPageNumber(int newPageNumber)

For MovePage ChangeTypes only. Sets the new page number value

Parameters:

newPageNumber - an integer representing the new page number

getNewPageNumber

public int getNewPageNumber()

Gets the value of the new page number field

Returns:

an integer value

Skip navigation links