net.doo.snap.entity

Class SnappingDraft

java.lang.Object

net.doo.snap.entity.SnappingDraft

All Implemented Interfaces:

android.os.Parcelable

public class SnappingDraft
extends java.lang.Object
implements android.os.Parcelable

Contains Pages and naming metadata necessary for document creation

See Also:

PageFactory

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SnappingDraft.NoPageByIndexException Thrown if page by index does not exist

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
static android.os.Parcelable.Creator<SnappingDraft>	CREATOR

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Modifier	Constructor and Description
	SnappingDraft(Page... pages)
protected	SnappingDraft(android.os.Parcel in)

Method Summary

Methods

Modifier and Type	Method and Description
void	addPage(int position, Page page) Adds page to given position
void	addPage(Page page) Adds page in the end
void	deletePage(int position) Deletes Page at given position
void	deletePage(Page page) Deletes Page if possible
int	describeContents()
java.lang.String	getDocumentName()
Page	getPage(int position)
java.util.List<Page>	getPages()
int	getPosition(Page page)
boolean	isCombined()
boolean	isEmpty()
void	replacePage(int position, Page page) Replaces page at given position with new page
void	setCombined(boolean isCombined)
void	setDocumentName(java.lang.String documentName)
int	size()
void	writeToParcel(android.os.Parcel dest, int flags)

Methods inherited from class java.lang.Object

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

Field Detail

CREATOR

public static final android.os.Parcelable.Creator<SnappingDraft> CREATOR

Constructor Detail

SnappingDraft

public SnappingDraft(Page... pages)

SnappingDraft

protected SnappingDraft(android.os.Parcel in)

Method Detail

addPage

public void addPage(Page page)

Adds page in the end

Parameters:

page -

addPage

public void addPage(int position,
           Page page)

Adds page to given position

Parameters:

position -

page -

replacePage

public void replacePage(int position,
               Page page)
                 throws SnappingDraft.NoPageByIndexException

Replaces page at given position with new page

Parameters:

position -

page -

Throws:

SnappingDraft.NoPageByIndexException

getPage

public Page getPage(int position)
             throws SnappingDraft.NoPageByIndexException

Parameters:

position -

Returns:

Page at given position

Throws:

SnappingDraft.NoPageByIndexException

deletePage

public void deletePage(int position)
                throws SnappingDraft.NoPageByIndexException

Deletes Page at given position

Parameters:

position -

Throws:

SnappingDraft.NoPageByIndexException

deletePage

public void deletePage(Page page)

Deletes Page if possible

Parameters:

page - Page to delete

getPosition

public int getPosition(Page page)

Parameters:

page -

Returns:

position of given page

size

public int size()

Returns:

count of pages stored in DocumentDraft

isEmpty

public boolean isEmpty()

Returns:

true if the holder has more than 0 pages, false otherwise

getPages

public java.util.List<Page> getPages()

Returns:

unmodifiable list of Pages snapped in the current session

getDocumentName

public java.lang.String getDocumentName()

Returns:

Document name to be saved on file system

setDocumentName

public void setDocumentName(java.lang.String documentName)

Parameters:

documentName - Document name to be saved on file system

isCombined

public boolean isCombined()

Returns:

true if draft should be saved as one document, false - otherwise

setCombined

public void setCombined(boolean isCombined)

Parameters:

isCombined - @code true} if draft should be saved as one document, false - otherwise

describeContents

public int describeContents()

Specified by:

describeContents in interface android.os.Parcelable

writeToParcel

public void writeToParcel(android.os.Parcel dest,
                 int flags)

Specified by:

writeToParcel in interface android.os.Parcelable