FlashPaper (com.digitalflipbook.controls.FlashPaper)

Component
        |
        +--com.digitalflipbook.controls.FlashPaper
class FlashPaper
extends Component

The FlashPaper class simplifies the process of working with the FlashPaper API.
Adds functionality either not documented or not provided in the API.

Availability:

ActionScript 1.0; Flash Player 6

Method summary

Method Description
load(path:String) : Void

Loads a FlashPaper document.
destroy() : Void

Unloads a FlashPaper document and all subobjects.
move(x:Number, y:Number) : Void

Moves the FlashPaper component to the requested position.
toString() : String

This returns the component's class name.
getIFlashPaper() : FlashPaper.IFlashPaper

This returns an object that implements the IFlashPaper interface.
If this function is not defined, then the SWF file is not a FlashPaper 2.0 document.
If this function exists, but returns a value of null or undefined, then the SWF file is a FlashPaper 2.0 document, but has not yet loaded enough to access the API; you must wait for it to load more fully and call it again.
getViewerType() : String

Returns a string describing the type of user interface that is included in the document.
The standard Macromedia FlashPaper viewer always returns the string Macromedia FlashPaper Default Viewer.
getViewerVersion() : Number

Returns an integer indicating the version of the user interface code in this particular document.
The returned integers are arbitrary and not necessarily consecutive,
but larger numbers indicate recent revisions to the viewer,
and might indicate bug fixes or enhanced functionality.
FlashPaper 2.01 shipped with a viewer version number of 218.
getCurrentPage() : Number

Returns the current page number (as displayed in the toolbar).
The first page is page 1.
setCurrentPage(pageNumber:Number) : Void

Sets the current page.
The view scrolls as necessary to ensure the page is visible, but does not adjust zoom.
getNumberOfPages() : Number

Returns the total number of pages in the document.
Note: All of the pages may not be able to be displayed yet, depending on the connection speed.
getLoadedPages() : Number

Returns the total number of pages loaded (and able to be displayed) so far.
This value must be between zero and getNumberOfPages(), inclusive.
When 

getLoadedPages() == getNumberOfPages()
, the document is fully loaded.
showUIElement(part:String, flag:Boolean) : Void

Hides or displays part of the user interface in the FlashPaper document.
The currently supported, case-sensitive values for part are the following:

"PrevNext" The Previous Page and Next Page toolbar buttons are hidden or shown.
Note: If these buttons are hidden, the Current Page text box is disabled, but not hidden.

"Print" The Print toolbar button is hidden or shown.

"Tool" All tool selection buttons on the toolbar are hidden or shown.

"Zoom" All zoom-related controls on the toolbar are hidden or shown.

"Find" All text-search-related controls on the toolbar are hidden or shown.

"Pop" The Open Document in New Browser Window toolbar button is hidden or shown.

"Sidebar" The sidebar (displaying the document outline) is hidden or shown.
Note: This value is ignored if the document does not contain an outline; documents without outlines never show a sidebar.

"Page" The Current Page and Number of Pages fields in the toolbar are hidden or shown.

"Overflow" The Overflow menu on the toolbar is hidden or shown.
Note: This menu appears only when the toolbar is too narrow to display all controls; you cannot use this call to force the Overflow menu to be visible.

"ZoomKeys" This value doesn't affect the user interface; it is used to enable or disable various keys used to zoom in or out of the document (for example, +, -, p, w).

"Brand" The Brand toolbar button is hidden or shown.

"Close" The Close toolbar button is hidden or shown.

traceUIElements() : Void

Traces the visiblity of the UI Elements.
printTheDocument() : Boolean

Simulates a user clicking the Print button.
The document must be fully loaded before you call this function.
getCurrentZoom() : Number

Returns the current zoom level.
Note: The zoom level always returns as a number; width and page are never returned.
setCurrentZoom(percent:Object) : Void

Sets the current zoom level.
You can pass a number indicating a zoom percentage
(for example, 100 for a 100% view).
You can also pass the string "width" to zoom to the current fit-to-width magnification for this document, or pass the string "page" for the fit-to-page magnification.
setSize(w:Number, h:Number) : Boolean

Sets the display arrange of the component, in pixels.
This function returns true if resize was successful, false if resize was unsuccessful.
goToLinkTarget(linktarget:String, window:Object) : Void

Handles an anchor or URL link request.
If the given string is a string of the form anchor:foo, the current view shifts to that anchor with a logical name of foo.
The window argument is ignored in this case.
If foo is not a valid anchor name in the document, no action is taken.
For all other strings, getURL(linktarget, window) is called.
(For more information, see the ActionScript documentation for this function.)
enableScrolling(flag:Boolean) : Boolean

Used to prevent the user from scrolling the document.
When scrolling is disabled, the following is true:

The scroll bar is disabled, but visible.
Panning (using the pointing hand) is disabled.
Scrolling using the mouse wheel is disabled.
getCurrentTool() : String

Returns the currently active tool.
If no tool is active, an empty string is returned.
The following are currently supported values:

"" (no tool)
"pan" (hand tool)
"select" (text selection tool)

setCurrentTool(tool:String) : Boolean

Makes the given tool the active tool.
This function returns false if the argument is invalid or the given tool is disabled.
The following are currently supported values:

"" (no tool)
"pan" (hand tool)
"select" (text selection tool)

getTextSelectionRange() : FlashPaper.SelectionRange

Returns an object describing the current text selection. If no text is selected, this function returns null.
Note: Unlike the object returned by getVisibleArea(), this call always returns a FlashPaper.SelectionRange, which is a well-defined object that you can examine, decompose, or construct new instances of.
setTextSelectionRange(sel:FlashPaper.SelectionRange, skipBroadcast:Boolean) : Void

Selects the given range of text. You may pass null to deselect all text. Invalid ranges for characters (not pages) are clipped to document ranges (this allows you to set a range that begins with zero and ends with a large number, such as 999999, to select the entire document). If skipBroadcast is false (or omitted), onVisibleAreaChanged() is broadcast to listeners as necessary. If skipBroadcast is true, onVisibleAreaChanged() is never broadcast to listeners.
Note: Unlike the object expected by setVisibleArea(), this call always expects a FlashPaper.SelectionRange, which is a well-defined object that you can examine, decompose, or construct new instances of.
getSelectedText() : String

Returns the selected text as a Unicode string.
If no text is selected, an empty string is returned.
getSidebarWidth() : Number

Returns the width of the sidebar.
A document with no outline always returns zero.
setSidebarWidth(w:Number) : Void

Sets the width of the sidebar.
Pass zero to hide the sidebar completely.
A document with no outline ignores this call.
getFindText() : String

Returns any text in the Find text box as a Unicode string.
setFindText(s:String) : Void

Sets the text in the Find text box to a Unicode string value.
This call does not perform a find operation or alter the current selection.
findNext() : Boolean

Searches for the text in the Find text box.
The search begins from the end of the current selection.
To start from the beginning of the document, call setSelectionRange(null) first.
If text is found, the specific range can be found by calling getTextSelectionRange().
getVisibleArea() : Object

Returns an object describing the current visible area of the document.
You can use the return value to do one of the following:

Pass to setVisibleArea().
This can be useful if the same document is being viewed on multiple computers, and you want to keep the visible areas in sync.

Compare with a previous value returned by getVisibleArea() to determine if the viewable area has changed.
The returned object should be considered an opaque data type.
Don't try to decompose the returned object, because its contents and format will probably change in future versions.
The only public member of the object we guarantee in future versions of the method is:
function equals(that:Object):Boolean;

You can use this to compare two visible areas to determine if they are the same.
setVisibleArea(area:Object, skipBroadcast:Boolean) : Void

Adjusts the currently visible page/zoom/scroll to match the visible area described by the area object.
If skipBroadcast is false (or omitted), onVisibleAreaChanged() is broadcast to listeners as necessary.
If skipBroadcast is true, onVisibleAreaChanged() is never broadcast to listeners.
This object must be one previously returned by getVisibleArea.
Don't try to construct your own object, because the contents and format will probably change in future versions.
documentPath() : String

The path of the FlashPaper document.
borderThickness() : Number

The thickness of the border.
borderColor() : String

The color of the border.
UIElements() : Object

The visiblity of the UI Elements.
currentZoom() : Object

The current zoom level.
backgroundTintColor() : String

The tint color of the background.
backgroundTintPercent() : Number

The tint percent of the background.
width() : Number

The width of the FlashPaper component.
height() : Number

The height of the FlashPaper component.

load(path:String) : Void

Usage

myFlashPaper.load(path);

Parameters

path:String - The local or remote address of the document to load.

Returns

Nothing.

Description

Loads a FlashPaper document.

destroy() : Void

Usage

myFlashPaper.destroy();

Parameters

Returns

Nothing.

Description

Unloads a FlashPaper document and all subobjects.

move(x:Number, y:Number) : Void

Usage

myFlashPaper.move(x, y);

Parameters

x:Number - A number that indicates the upper left corner position of the FlashPaper component.

y:Number - A number that indicates the upper left corner position of the FlashPaper component.

Returns

Nothing.

Description

Moves the FlashPaper component to the requested position.

toString() : String

Usage

myFlashPaper.toString();

Parameters

Returns

"FlashPaper"

Description

This returns the component's class name.

getIFlashPaper() : FlashPaper.IFlashPaper

Usage

myFlashPaper.getIFlashPaper();

Parameters

Returns

The FlashPaper interface.

Description

This returns an object that implements the IFlashPaper interface.
If this function is not defined, then the SWF file is not a FlashPaper 2.0 document.
If this function exists, but returns a value of null or undefined, then the SWF file is a FlashPaper 2.0 document, but has not yet loaded enough to access the API; you must wait for it to load more fully and call it again.

getViewerType() : String

Usage

myFlashPaper.getViewerType();

Parameters

Returns

The viewer type.

Description

Returns a string describing the type of user interface that is included in the document.
The standard Macromedia FlashPaper viewer always returns the string Macromedia FlashPaper Default Viewer.

getViewerVersion() : Number

Usage

myFlashPaper.getViewerVersion();

Parameters

Returns

The viewer version.

Description

Returns an integer indicating the version of the user interface code in this particular document.
The returned integers are arbitrary and not necessarily consecutive,
but larger numbers indicate recent revisions to the viewer,
and might indicate bug fixes or enhanced functionality.
FlashPaper 2.01 shipped with a viewer version number of 218.

getCurrentPage() : Number

Usage

myFlashPaper.getCurrentPage();

Parameters

Returns

The current page.

Description

Returns the current page number (as displayed in the toolbar).
The first page is page 1.

setCurrentPage(pageNumber:Number) : Void

Usage

myFlashPaper.setCurrentPage(pageNumber);

Parameters

pageNumber:Number - Page number to set.

Returns

Nothing.

Description

Sets the current page.
The view scrolls as necessary to ensure the page is visible, but does not adjust zoom.

getNumberOfPages() : Number

Usage

myFlashPaper.getNumberOfPages();

Parameters

Returns

The total number of pages in the document.

Description

Returns the total number of pages in the document.
Note: All of the pages may not be able to be displayed yet, depending on the connection speed.

getLoadedPages() : Number

Usage

myFlashPaper.getLoadedPages();

Parameters

Returns

The number of pages currently loaded.

Description

Returns the total number of pages loaded (and able to be displayed) so far.
This value must be between zero and getNumberOfPages(), inclusive.
When 

getLoadedPages() == getNumberOfPages()
, the document is fully loaded.

showUIElement(part:String, flag:Boolean) : Void

Usage

myFlashPaper.showUIElement(part, flag);

Parameters

part:String - The UI element to show or hide.

flag:Boolean - If true, shows the UI element. If false, hides the UI element.

Returns

Nothing.

Description

Hides or displays part of the user interface in the FlashPaper document.
The currently supported, case-sensitive values for part are the following:

"PrevNext" The Previous Page and Next Page toolbar buttons are hidden or shown.
Note: If these buttons are hidden, the Current Page text box is disabled, but not hidden.

"Print" The Print toolbar button is hidden or shown.

"Tool" All tool selection buttons on the toolbar are hidden or shown.

"Zoom" All zoom-related controls on the toolbar are hidden or shown.

"Find" All text-search-related controls on the toolbar are hidden or shown.

"Pop" The Open Document in New Browser Window toolbar button is hidden or shown.

"Sidebar" The sidebar (displaying the document outline) is hidden or shown.
Note: This value is ignored if the document does not contain an outline; documents without outlines never show a sidebar.

"Page" The Current Page and Number of Pages fields in the toolbar are hidden or shown.

"Overflow" The Overflow menu on the toolbar is hidden or shown.
Note: This menu appears only when the toolbar is too narrow to display all controls; you cannot use this call to force the Overflow menu to be visible.

"ZoomKeys" This value doesn't affect the user interface; it is used to enable or disable various keys used to zoom in or out of the document (for example, +, -, p, w).

"Brand" The Brand toolbar button is hidden or shown.

"Close" The Close toolbar button is hidden or shown.

traceUIElements() : Void

Usage

myFlashPaper.traceUIElements();

Parameters

Returns

Nothing.

Description

Traces the visiblity of the UI Elements.

printTheDocument() : Boolean

Usage

myFlashPaper.printTheDocument();

Parameters

Returns

Returns false if the document is not fully loaded.

Description

Simulates a user clicking the Print button.
The document must be fully loaded before you call this function.

getCurrentZoom() : Number

Usage

myFlashPaper.getCurrentZoom();

Parameters

Returns

The current zoom level of the document.

Description

Returns the current zoom level.
Note: The zoom level always returns as a number; width and page are never returned.

setCurrentZoom(percent:Object) : Void

Usage

myFlashPaper.setCurrentZoom(percent);

Parameters

percent:Object - The zoom level to set the FlashPaper document.

Returns

Nothing.

Description

Sets the current zoom level.
You can pass a number indicating a zoom percentage
(for example, 100 for a 100% view).
You can also pass the string "width" to zoom to the current fit-to-width magnification for this document, or pass the string "page" for the fit-to-page magnification.

setSize(w:Number, h:Number) : Boolean

Usage

myFlashPaper.setSize(w, h);

Parameters

w:Number - Width to set the FlashPaper document.

h:Number - Height to set the FlashPaper document.

Returns

Generally speaking, this function fails (returns false) if the document isn't fully loaded.

Description

Sets the display arrange of the component, in pixels.
This function returns true if resize was successful, false if resize was unsuccessful.

goToLinkTarget(linktarget:String, window:Object) : Void

Usage

myFlashPaper.goToLinkTarget(linktarget, window);

Parameters

linktarget:String - Anchor or URL link to load.

window:Object - An optional parameter specifying the window or HTML frame into which the document should load.

Returns

Nothing.

Description

Handles an anchor or URL link request.
If the given string is a string of the form anchor:foo, the current view shifts to that anchor with a logical name of foo.
The window argument is ignored in this case.
If foo is not a valid anchor name in the document, no action is taken.
For all other strings, getURL(linktarget, window) is called.
(For more information, see the ActionScript documentation for this function.)

enableScrolling(flag:Boolean) : Boolean

Usage

myFlashPaper.enableScrolling(flag);

Parameters

flag:Boolean - True or false to enable scrolling.

Returns

The return value is the previous value of this flag.

Description

Used to prevent the user from scrolling the document.
When scrolling is disabled, the following is true:

The scroll bar is disabled, but visible.
Panning (using the pointing hand) is disabled.
Scrolling using the mouse wheel is disabled.

getCurrentTool() : String

Usage

myFlashPaper.getCurrentTool();

Parameters

Returns

The current tool.

Description

Returns the currently active tool.
If no tool is active, an empty string is returned.
The following are currently supported values:

"" (no tool)
"pan" (hand tool)
"select" (text selection tool)

setCurrentTool(tool:String) : Boolean

Usage

myFlashPaper.setCurrentTool(tool);

Parameters

tool:String - Tool to make active.

Returns

If the tool was set successfully.

Description

Makes the given tool the active tool.
This function returns false if the argument is invalid or the given tool is disabled.
The following are currently supported values:

"" (no tool)
"pan" (hand tool)
"select" (text selection tool)

getTextSelectionRange() : FlashPaper.SelectionRange

Usage

myFlashPaper.getTextSelectionRange();

Parameters

Returns

The current text selection range.

Description

Returns an object describing the current text selection. If no text is selected, this function returns null.
Note: Unlike the object returned by getVisibleArea(), this call always returns a FlashPaper.SelectionRange, which is a well-defined object that you can examine, decompose, or construct new instances of.

setTextSelectionRange(sel:FlashPaper.SelectionRange, skipBroadcast:Boolean) : Void

Usage

myFlashPaper.setTextSelectionRange(sel, skipBroadcast);

Parameters

sel:FlashPaper.SelectionRange - FlashPaper.SelectionRange.

skipBroadcast:Boolean - If false or omitted, onVisibleAreaChanged() is broadcast. If true, the event is not broadcast.

Returns

Nothing.

Description

Selects the given range of text. You may pass null to deselect all text. Invalid ranges for characters (not pages) are clipped to document ranges (this allows you to set a range that begins with zero and ends with a large number, such as 999999, to select the entire document). If skipBroadcast is false (or omitted), onVisibleAreaChanged() is broadcast to listeners as necessary. If skipBroadcast is true, onVisibleAreaChanged() is never broadcast to listeners.
Note: Unlike the object expected by setVisibleArea(), this call always expects a FlashPaper.SelectionRange, which is a well-defined object that you can examine, decompose, or construct new instances of.

getSelectedText() : String

Usage

myFlashPaper.getSelectedText();

Parameters

Returns

The text currently selected.

Description

Returns the selected text as a Unicode string.
If no text is selected, an empty string is returned.

getSidebarWidth() : Number

Usage

myFlashPaper.getSidebarWidth();

Parameters

Returns

The width of the sidebar.

Description

Returns the width of the sidebar.
A document with no outline always returns zero.

setSidebarWidth(w:Number) : Void

Usage

myFlashPaper.setSidebarWidth(w);

Parameters

w:Number - Width to set sidebar.

Returns

Nothing.

Description

Sets the width of the sidebar.
Pass zero to hide the sidebar completely.
A document with no outline ignores this call.

getFindText() : String

Usage

myFlashPaper.getFindText();

Parameters

Returns

The text in the Find text box as a Unicode string.

Description

Returns any text in the Find text box as a Unicode string.

setFindText(s:String) : Void

Usage

myFlashPaper.setFindText(s);

Parameters

s:String - Text to set in the Find text box.

Returns

Nothing.

Description

Sets the text in the Find text box to a Unicode string value.
This call does not perform a find operation or alter the current selection.

findNext() : Boolean

Usage

myFlashPaper.findNext();

Parameters

Returns

Returns true if text is found, false if not.

Description

Searches for the text in the Find text box.
The search begins from the end of the current selection.
To start from the beginning of the document, call setSelectionRange(null) first.
If text is found, the specific range can be found by calling getTextSelectionRange().

getVisibleArea() : Object

Usage

myFlashPaper.getVisibleArea();

Parameters

Returns

The current visible area of the document.

Description

Returns an object describing the current visible area of the document.
You can use the return value to do one of the following:

Pass to setVisibleArea().
This can be useful if the same document is being viewed on multiple computers, and you want to keep the visible areas in sync.

Compare with a previous value returned by getVisibleArea() to determine if the viewable area has changed.
The returned object should be considered an opaque data type.
Don't try to decompose the returned object, because its contents and format will probably change in future versions.
The only public member of the object we guarantee in future versions of the method is:
function equals(that:Object):Boolean;

You can use this to compare two visible areas to determine if they are the same.

setVisibleArea(area:Object, skipBroadcast:Boolean) : Void

Usage

myFlashPaper.setVisibleArea(area, skipBroadcast);

Parameters

area:Object - Object to match current visible area with.

skipBroadcast:Boolean - If false or omitted, onVisibleAreaChanged() is broadcast. If true, the event is not broadcast.

Returns

Nothing.

Description

Adjusts the currently visible page/zoom/scroll to match the visible area described by the area object.
If skipBroadcast is false (or omitted), onVisibleAreaChanged() is broadcast to listeners as necessary.
If skipBroadcast is true, onVisibleAreaChanged() is never broadcast to listeners.
This object must be one previously returned by getVisibleArea.
Don't try to construct your own object, because the contents and format will probably change in future versions.

documentPath() : String

Usage

myFlashPaper.documentPath = path;

Parameters

Returns

Nothing.

Description

The path of the FlashPaper document.

borderThickness() : Number

Usage

myFlashPaper.borderThickness = thickness;

Parameters

Returns

Nothing.

Description

The thickness of the border.

borderColor() : String

Usage

myFlashPaper.borderColor = color;

Parameters

Returns

Nothing.

Description

The color of the border.

UIElements() : Object

Usage

myFlashPaper.UIElements = elements;

Parameters

Returns

Nothing.

Description

The visiblity of the UI Elements.

currentZoom() : Object

Usage

myFlashPaper.currentZoom = percent;

Parameters

Returns

Nothing.

Description

The current zoom level.

backgroundTintColor() : String

Usage

myFlashPaper.backgroundTintColor = color;

Parameters

Returns

Nothing.

Description

The tint color of the background.

backgroundTintPercent() : Number

Usage

myFlashPaper.backgroundTintPercent = percent;

Parameters

Returns

Nothing.

Description

The tint percent of the background.

width() : Number

Usage

myFlashPaper.width = w;

Parameters

Returns

Nothing.

Description

The width of the FlashPaper component.

height() : Number

Usage

myFlashPaper.height = h;

Parameters

Returns

Nothing.

Description

The height of the FlashPaper component.