Class adobeDPS-Section

Representation of a Section object.

Constructor

adobeDPS-Section()

[inner] Creates an instance of a Section.

	Field	Defined By
	parentFolio : Boolean The designated parent Folio of this section.	Section
	isAtHeadOfDownloadQueue : Boolean Indicates whether this Section is at the head of the download queue.	Section
	index : Number The index of this section in native sections array.	Section
	updatedSignal : adobeDPS-Signal Signal to indicate that this BaseFolio has been updated.	BaseFolio
	id : String The Unique id of this BaseFolio.	BaseFolio
	currentTransactions : Array The current transactions acting on this BaseFolio.	BaseFolio
	downloadSize : Number The size of this BaseFolio in Bytes.	BaseFolio
	state : adobeDPS-FolioState = adobeDPS-FolioState.INVALID The State of this BaseFolio.	BaseFolio
	previewImageURL : String The local file URL of the preview image for this BaseFolio.	BaseFolio
	title : String The title of this BaseFolio.	BaseFolio
	isCompatible : Boolean This indicates whether this BaseFolio is compatible with this version of the viewer.	BaseFolio
	isDownloadable : Boolean Whether the BaseFolio is currently able to be downloaded.	BaseFolio
	isViewable : Boolean Whether the BaseFolio is currently able to be viewed.	BaseFolio
	isArchivable : Boolean Whether the BaseFolio is currently able to be archived.	BaseFolio
	isUpdatable : Boolean This indicates whether this BaseFolio is currently updatable.	BaseFolio

	Method	Defined By
	download() Start a download transaction on this BaseFolio.	BaseFolio
	view() Start a view transaction on this BaseFolio.	BaseFolio
	getPreviewImage(width:Number, height:Number, isPortrait) Start a preview image transaction on this BaseFolio.	BaseFolio
	currentStateChangingTransaction() Helper method to discover the current state changing transaction on a BaseFolio (if any)	BaseFolio
	toString() Gets the string representation of this instance.	Class

Class Detail

adobeDPS-Section()

[inner] Creates an instance of a Section.

Field Details

parentFolio : Boolean

The designated parent Folio of this section.

isAtHeadOfDownloadQueue : Boolean

Indicates whether this Section is at the head of the download queue.

index : Number

The index of this section in native sections array.