FlashPaper組件——api

標籤：des   style   c   code   tar   ext   

屬性摘要

屬性	說明
documentPath:String	FlashPaper檔案的路徑.
borderThickness:Number	邊框寬度.
borderColor:String	邊框顏色.
UIElements:Object	外觀元素的可見度.
currentZoom:Object	預設縮放比例.
width:Number	FlashPaper檔案的寬度.
height:Number	FlashPaper檔案的高度.

 

 

 

 

 

 

 

 

 

 

 

UIElements屬性的圖示

 

   

事件摘要

 

事件	說明
onLoadStart = function(target:FlashPaper, type:String) {}	當FlashPape檔案已開始下載檔案時調用.
onLoadProgress = function(target:FlashPaper, type:String, bytesLoaded:Number, bytesTotal:Number) {}	每當FlashPape檔案寫入硬碟時調用.
onLoadComplete = function(target:FlashPaper, type:String) {}	當FlashPape檔案完全下載時調用.
onLoadInit = function(target:FlashPaper, type:String) {}	當執行FlashPape檔案第一幀上的動作時調用.
onLoadError = function(target:FlashPaper, type:String, errorCode:String) {}	當FlashPape檔案未能載入時調用.
onDisplay = function(target:FlashPaper, type:String) {}	當FlashPape檔案已經顯示時調用.
onUnload = function(target:FlashPaper, type:String) {}	當卸載FlashPape檔案時調用.
onPageChanged = function(target:FlashPaper, type:String, newPageNumber:Number) {}	當FlashPape檔案翻頁時調用.
onZoomChanged = function(target:FlashPaper, type:String, percent:Number) {}	當FlashPape檔案縮放時調用.
onSelection = function(target:FlashPaper, type:String) {}	當FlashPape檔案的文字被選擇時調用.
onToolChanged = function(target:FlashPaper, type:String, newTool:String) {}	當更換FlashPape檔案的工具時調用.
onEnableScrolling = function(target:FlashPaper, type:String, enable:Boolean) {}	當FlashPape檔案滾動時調用.
onVisibleAreaChanged = function(target:FlashPaper, type:String) {}	當FlashPape檔案的哭件地區變化時調用.

 

方法摘要

 

方法	說明
load(path:String) : Void	載入一個FlashPape檔案.
destroy() : Void	卸載FlashPape檔案.
move(x:Number, y:Number) : Void	移動FlashPape組件).
toString() : String	返回組件的名稱.
getIFlashPaper() : FlashPaper.IFlashPaper	返回一個實現IFlashPaper介面的對象. 如果這個函數未定義,那麼載入的SWF檔案不是一個FlashPaper 2.0檔案. 如果這個函數存在,但是返回null或undefined,那麼載入的SWF檔案是一個FlashPaper 2.0檔案,但是還沒有載入足夠的內容去實現這個API;你必須等待載入足夠的內容並且再次調用它.
getViewerType() : String	返回一個描述包含SWF檔案的介面的類型的字串. 這個Macromedia FlashPaper標準閱讀器總是返回Macromedia FlashPaper Default Viewer.
getViewerVersion() : Number	返回一個標識這個檔案介面版本代號整數. 返回的整數不是連續的,但是這個整數顯示閱讀器最近的版本 ,而且可以顯示除錯或增強功能. 比如FlashPaper 2.01返回 218.
getCurrentPage() : Number	返回當前頁數(與工具列顯示的相同).第一頁是1.
setCurrentPage(pageNumber:Number) : Void	設定當前頁數.需要保證此頁是可顯示的,但不必調節縮放.
getNumberOfPages() : Number	返迴文件總頁數. 注意: 也許不是所有的頁都是可顯示的, 屈就於連線速度.
getLoadedPages() : Number	返回當前載入的頁數(可顯示的). 這個數值一定在0到getNumberOfPages()之間. 當 getLoadedPages() == getNumberOfPages() 時,這個檔案便完全載入.
showUIElement(part:String, flag:Boolean) : Void	應藏或者顯示FlashPaper檔案外觀的組件.區分大小寫: "PrevNext" 前一頁和後一頁按鈕的隱藏或顯示. 注意: 如果這些按鈕是隱藏的,當前頁文字框回失效,但不會隱藏. "Print" 列印按鈕的隱藏或顯示. "Tool"所有工具選擇按鈕的隱藏或顯示. "Zoom" 所有所放控制按鈕的隱藏或顯示. "Find"文字搜尋方塊的隱藏或顯示. "Pop" 在瀏覽器中開啟檔案按鈕的隱藏或顯示. "Sidebar"邊框 (顯示檔案邊框)按鈕的隱藏或顯示. 注意: 這個變數無論這個檔案是否包括邊框i; 沒有邊框的檔案從不顯示邊框按鈕. "Page" 當前頁和總頁數按鈕的隱藏或顯示 "Overflow" 超出菜單的隱藏或顯示. 注意:這個菜單僅在工具條太狹窄而不能顯示時;你不能用這個變數強制顯示超出菜單. "ZoomKeys" 這個參數不影響外觀;他控制是否能用快速鍵所放檔案(例如, +, -, p, w). "Brand" 品牌按鈕的隱藏或顯示.[註：此屬性設定false也無法隱藏左上方FlashPaper的標誌，估計是因為Adobe不太希望自己的標誌被隱藏，既然這樣，不知道這個Brand還存在於API中還有什麼意義] "Close" 關閉按鈕的隱藏或顯示.
traceUIElements() : Void	輸出UI Elements的可見度.
printTheDocument() : Boolean	模仿使用者單擊答應按鈕. 在調用函數前,檔案必須完全載入.
getCurrentZoom() : Number	返回當前縮放水平. 注意: 縮放水平總是返回一個數值r;不會返回頁面寬度.
setCurrentZoom(percent:Object) : Void	設定當前縮放水平.你可以傳入一個數值指示所放百分比 (例如, 100表示100%)..你也可以傳入一個字串 "width"適合頁面寬度,或者傳入字串 "page"適合到頁.
setSize(w:Number, h:Number) : Boolean	設定組件的顯示排列,單位是象素. 如果成功設定則返回true,不成功則返回false.
goToLinkTarget(linktarget:String, window:Object) : Void	觸發錨點或URL串連請求. 如果傳入的字串是錨點名稱:foo,當前視圖會移動到那個錨點.window參數會被忽視.如果foo不是一個有效錨點名稱,則不會執行動作.對於其它的字串,會執行getURL(linktarget, window) (想瞭解更多的資訊,請見ActionScript文檔).
enableScrolling(flag:Boolean) : Boolean	阻止使用者滾動檔案.當滾動被禁止時: 捲軸不可用,但是可見. 滾動按鈕不可用. 使用滑鼠滾輪滾動不可用.
getCurrentTool() : String	返回當前活動的工具.如果沒有活動的工具,則返回Null 字元串.以下是現在支援的值: "" (沒有工具) "pan" (手形工具) "select" (文字選擇工具)
setCurrentTool(tool:String) : Boolean	設定活動工具.如果參數錯誤或者該工具不可用則返回false.以下是現在支援的值: "" (沒有工具) "pan" (手形工具) "select" (文字選擇工具)
getTextSelectionRange() : FlashPaper.SelectionRange	返回一個描述當前選擇文字的對象.如果沒有選擇文字,則返回null. 注意:與getVisibleArea()返回的對象不同,這個函數總是返回一個FlashPaper.SelectionRange,這是一個明確定義的對象, 你可以檢查,分解或者構造一個新的對象.
setTextSelectionRange(sel:FlashPaper.SelectionRange, skipBroadcast:Boolean) : Void	選擇特定的文字.你可以傳入null,從而取消選定所有的文字.無效的範圍(沒有頁面)會被省略(它允許你定義範圍從0到一個很大的數,例如999999,從而選定所有文檔).如果skipBroadcast是false (或未定義), 會廣播onVisibleAreaChanged(). 如果skipBroadcast是true, 則不會廣播onVisibleAreaChanged(). 注意:與getVisibleArea()返回的對象不同,這個函數總是返回一個FlashPaper.SelectionRange,這是一個明確定義的對象, 你可以檢查,分解或者構造一個新的對象.
getSelectedText() : String	以Unicode編碼的字串返回選擇的文字.如果每有被選擇的文字,會返回Null 字元串.
getSidebarWidth() : Number	返回其他按鈕的寬度. 沒有邊框的檔案會返回0.
setSidebarWidth(w:Number) : Void	設定其他按鈕的寬度. 傳入0從而完全隱藏其他按鈕. 沒有邊框的檔案會忽視調用.
getFindText() : String	以Unicode編碼的字串返回尋找的文字.
setFindText(s:String) : Void	設定文字尋找框的文字. 這個函數不會執行尋找操作或改變當前選擇.
findNext() : Boolean	尋找文字尋找框中輸入的文字. 從當前選擇文字的後面開始尋找. 要從文檔的開頭尋找,請先調用setSelectionRange(null). 如果找到了文字,調用getTextSelectionRange()返回詳細的範圍.
getVisibleArea() : Object	返回描述文檔當前可見地區的對象.返回的對象有如下作用: 傳入setVisibleArea(). 這個可以用來在不同的電腦上觀看同一文檔,而且可以保持同步. 與先前getVisibleArea()返回的對象進行比較,測試可見地區是否改變. 返回的對象應該被認為是封閉的資料結構.不要試圖分解返回的對象,因為在將來的版本中內容的格式可能不同. 這個對象唯一不變的方法是: function equals(that:Object):Boolean; 我們可以用它比較兩個可見地區是否相同.
setVisibleArea(area:Object, skipBroadcast:Boolean) : Void	調節當前可見的頁/縮放/滾動從而匹配給定的地區對象. 如果skipBroadcast是false (或未定義), 會廣播onVisibleAreaChanged().如果skipBroadcast是true, 則不會廣播onVisibleAreaChanged(). 傳入的對象必須是先前由getVisibleArea返回的對象. 不要試圖建立你自己的對象,因為在將來的版本中內容的格式可能不同.