WebViewer Xtra ver.1.5.1 ユーザーズマニュアル

Copyright (C) 2005 Xtras.jp
All rights reserved.


概要

初めてのクロスプラットフォーム対応ウェブブラウザ埋め込みXtra、誕生。

WindowsではInternet Explorer、MacintoshではSfariの機能を、Directorのムービー内に実現します。HTMLの表示はもちろん、両プラットフォーム共通のLingoスクリプトによって、ハイパーリンクのジャンプ先の制御やコンテキストメニューの制限など、ブラウザ機能の詳細な制御が可能。レンダリング結果のイメージ取得、JavaScriptの実行など、プラスアルファの機能も備えます。

利用例

動作環境

オーサリング環境

Windowsプラットフォーム

Macintoshプラットフォーム

インストール方法

Windows版Directorへのインストール

Windows版パッケージをダウンロードし、適当な場所に展開します。

DirectorアプリケーションのXtrasフォルダ内に、WebViewer.x32ファイルをコピーします。Xtraフォルダの場所はパスは環境により異なります。デフォルトの場所にDirectorをインストールしている場合、最終的なXtraのファイルパスは以下のようになります。

Director 8.5 : C:\Program Files\Macromedia\Director\Director 8.5\Xtras\WebViewer.x32
Director MX : C:\Program Files\Macromedia\Director\Director MX\Xtras\WebViewer.x32
Director MX2004 : C:\Program Files\Macromedia\Director\Director MX 2004\Configuration\Xtras\WebViewer.x32

もし古いバージョンのWebViewer Xtraがインストールされている場合、これを削除して新しいバージョンに置き換えます。

Directorを再起動すると、メニューの[挿入] -> [Xtras.jp] -> [WebViewer]からXtraが利用できるようになります。

Macintosh版Directorへのインストール

Macintosh版パッケージをダウンロードし、適当な場所に展開します。

DirectorアプリケーションのXtrasフォルダ内に、MacOSXフォルダ内にあるWebViewerファイルおよびWebViewer.bundleフォルダ(ファイル)をコピーします。Xtraフォルダの場所はパスは環境により異なります。デフォルトの場所にDirectorをインストールしている場合、最終的なXtraのファイルパスは以下のようになります。

DirectorMX : OSX Volume Name/Applications/Macromedia Director MX/Xtras/WebViewer
DirectorMX : OSX Volume Name/Applications/Macromedia Director MX/Xtras/WebViewer.bundle

DirectorMX2004 : OSX Volume Name/Applications/Macromedia Director MX 2004/Configuration/Xtras/WebViewer
DirectorMX2004 : OSX Volume Name/Applications/Macromedia Director MX 2004/Configuration/Xtras/WebViewer.bundle

MacOSX版のWebViewer Xtraは、必ずこれらWebViewerファイルとWebViewer.bundleフォルダ(ファイル)が同じフォルダに置かれている必要があります。もし古いバージョンのWebViewer Xtraがインストールされている場合、これを削除して新しいバージョンに置き換えます。

Directorを再起動すると、メニューの[挿入] -> [Xtras.jp] -> [WebViewer]からXtraが利用できるようになります。

利用方法

Directorでのオーサリング方法

WebViewer XtraはアセットXtraです。アセットXtraは、Directorに組み込まれている他のメディアと同様に、スコアやキャストウィンドウにて扱うことができます。Directorのメニューから[挿入] -> [Xtras.jp] -> [WebViewer]を選択すると、キャストにWebViewer Xtraが追加されます。これをステージに配置すると、中央に[WebViewer Xtra ver.1.0]と表示された透明なスプライトが表示されます。このスプライトの位置やサイズを調節することによって、ウェブブラウザの表示されるエリアを設定することができます。Directorムービーを再生し、実行中にメッセージエリアから下記のLingoコマンドを実行すると、ウェブサイトを表示することができます。

(sprite 1).Navigate("http://www.macromedia.com")

ハンドラから同様にコマンドを実行するためには、スコアウィンドウ中でスプライトが表示された後のフレームをダブルクリックし、開いたスクリプトウィンドウで下記のように入力します。

on exitFrame me
(sprite 1).Navigate("http://www.macromedia.com")
end

このように、ナビゲーションなどの操作は必ずスプライトが表示された後で行うようにしてください。

このWebViewer XtraはWindowsとMacintoshの両プラットフォームとも、ウェブブラウザ画面はステージの最前面に張り付いた別ウィンドウとして表示されています。他のスプライトをウェブブラウザ画面の上には配置できません。

ムービーの再生を停止すると、WebViewer Xtraのスプライトは最後に表示されていたウェブブラウザ画面を残したビットマップスプライトになります。この状態はスコアウィンドウの再生ヘッドがスプライトのあるフレームから出るまでしか続きませんが、ウェブブラウザ画面のイメージのままオーサリングを続けることができます。

WebViewer Xtraの各種機能についての詳細は、このマニュアルのリファレンスや付属のデモアプリケーションを参考にして下さい。

Windows用プロジェクターでの利用

Windows用のプロジェクターアプリケーション内でWebViewerを利用するには、プロジェクターアプリケーションのあるフォルダにXtrasフォルダを作り、その中にWebViewer.x32ファイルをコピーします。または、Directorのメニューから[設定] -> [ムービー] -> [エクストラ]を選択し、表示されるダイアログ内で[WebViewer.x32]の[プロジェクタに含む]にチェックを入れて、プロジェクターアプリケーション自体に内包させます。

Macitosh用プロジェクターでの利用

MacOSX用のプロジェクターアプリケーション内でWebViewerを利用するには、プロジェクターアプリケーションのあるフォルダにXtrasフォルダを作り、その中にWebViewerファイルおよびWebViewer.bundleフォルダ(ファイル)をコピーします。

MacOSX用のWebViewer Xtraは、必ずこれらWebViewerファイルとWebViewer.bundleフォルダ(ファイル)が同じフォルダに置かれている必要があります。この理由から、Macintosh用プロジェクターではWebViewer Xtraをプロジェクターに内包することができません。

Shockwaveでの利用

※ WebViewer Xtra では、セキュリティー上の観点から、Shockwave内での動作には対応しておりません。

Lingo リファレンス

キャストメンバプロパティ

available (integer型、読み取り専用)

WebViewer Xtraが利用できる環境では1(true)、利用できない環境では0(false)を返します。

例: put (member "WebViewer").available

browserVersion (string型、読み取り専用)

インストールされているウェブブラウザのバージョンを返します。WindowsプラットフォームではInternet Explorerのバージョン、MacintoshプラットフォームではSafariのレンダリングエンジンであるWebKitのバージョンになります。

例: put (member "WebViewer").browserVersion

-- "6.0.2800.1106" <- Windows
-- "1.2" <- Macintosh

version (string型、読み取り専用)

インストールされているWebViewer Xtraのバージョンを返します。

例: put (member "WebViewer").version

-- "1.32"

hideOnStart (integer型)

スプライトの初期状態表示状態を設定します。非表示状態で初期化するには1(true)、表示状態で初期化する場合は0(false)を設定します。

例: (member "WebViewer").hideOnStart = 1

キャストメンバメソッド

Register(memberRef型 member, string型 serial)

WebViewer Xtraのレジストレーションを行います。WebViewer XtraはDirector上でのオーサリング中はすべての機能が使えますが、プロジェクター上ではレジストレーションを行わないとウェブブラウザ画面が表示されません。最初にNavigateメソッドを実行する前にレジストレーションを実行して下さい。

例: (member 1).Register("123456789")

スプライトプロパティ

busy (integer型、読み取り専用)

現在ページを読み込み中の時は1(true)、読み込みが完了している時は0(false)を返します。

例: put (sprite 1).busy

baseURL (string型)

"html"スプライトプロパティで文字列としてHTMLを与えて表示する際の、相対パスの基準となるベースURLを設定します。WebKitの仕様から、ローカルのパスを設定する際には、存在するファイルのパスを与える必要があります。Macintoshプラットフォームのみで有効です(Windowsプラットフォームでは設定しても効果がありません)。

例: (sprite 1).base = "http://www.xtras.jp"
例: (sprite 1).base = the moviePath & the movieName

cancelNavigation (integer型)

ページナビゲーションを抑制します。ページナビゲーションを抑制する場合は1(true)、通常通りのページナビゲーションを行うには0(false)を設定します。

例: (sprite 1).cancelNavigation = 1

cancelNewWindow (integer型)

新しいブラウザウィンドウを開く(あるいは現在のページから移動する)のを抑制します。新ウィンドウを開く操作を無視する場合は1(true)、新しいページを現在のウェブブラウザ上に表示するには0(false)を設定します。

例: (sprite 1).cancelNewWindow = 1

contextMenu (integer型)

ウェブブラウザ画面上でマウスの右ボタンクリックやControlキーを押しながらクリックすることで表示されるコンテキストメニューを抑制します。通常通りコンテキストメニューを表示する場合は1(true)、抑制する場合は0(false)を設定します。

例: (sprite 1).contextMenu = 1

html (string型)

ウェブブラウザ画面で表示するHTMLを文字列で与えたり、現在表示中のページのHTMLソースを取得したりすることができます。

例: (sprite 1).html = "<html><body>Hello world !!</body></html>

image (image型、読み取り専用)

現在表示中のウェブブラウザ画面をキャプチャし、イメージオブジェクトとして取得することができます。キャプチャ時にはウェブブラウザ画面上に他のウィンドウなどが重ならないように注意して下さい。

例: (member "img").image = (sprite 1).image

locationName (string型、読み取り専用)

現在表示中のページタイトルを返します。常に最新のページタイトルを表示するには、titleChangeイベントハンドラを利用します。

例: put (sprite 1).locationName

locationURL (string型、読み取り専用)

現在表示中のページのURLを返します。

例: put (sprite 1).locationURL

offline (integer型)

ウェブブラウザをオフラインモードで動作させます。オフラインモードでは、ページをキャッシュデータを使って表示します。オフラインモードにする場合は1(true)を、オフラインモードを解除するには0(false)を設定します。Windowsプラットフォームのみで有効です(Macintoshプラットフォームでは設定しても効果がありません)。

例: (sprite 1).offline = 1

readyState (integer型、読み取り専用)

現在のウェブブラウザの動作状態を返します。状態は以下に示す値のいずれかになります。得られる値やタイミングはプラットフォームによって異なる場合があります。Windowsプラットフォームにおいて、htmlプロパティでページ内容を指定して読み込んだ時のreadyState値は不定です。

readyState値 状態
0 デフォルトの初期化状態
1 オブジェクトはプロパティをロード中
2 オブジェクトは初期化された
3 オブジェクトは応答可能だが、利用できないデータがある
4 オブジェクトはデータをすべて受け取った
例: put (sprite 1).readyState

scrollBars (integer型)

ウェブブラウザ画面でスクロールバーの表示・非表示を設定します。スクロールバーを表示する場合は1(true)を、非表示にする場合は0(false)を設定します。Internet Explorer 5.0およびSafariでは、このプロパティでスクロールバーを消すことはできません。

例: (sprite 1).scrollBars = 1

scrollWidth (integer型, 読み取り専用)

現在表示されているページの全体の幅を返します。独自のスクロールバーを実装する際に利用できます。

例: put (sprite 1).scrollWidth

scrollHeight (integer型, 読み取り専用)

現在表示されているページの全体の高さを返します。独自のスクロールバーを実装する際に利用できます。

例: put (sprite 1).scrollHeight

scrollLeft (integer型)

現在表示されているページおける、現在表示されている領域の左端の位置を設定・取得します。独自のスクロールバーを実装する際に利用できます。

例: (sprite 1).scrollLeft = 10

scrollTop (integer型)

現在表示されているページおける、現在表示されている領域の上端の位置を設定・取得します。独自のスクロールバーを実装する際に利用できます。

例: (sprite 1).scrollTop = 10

silent (integer型)

別ウィンドウでJavaScriptエラーによるダイアログボックスが表示されるのを抑制します。ダイアログボックスの表示を抑制する場合は1(true)を、通常通り抑制しない場合は0(false)を設定します。Windowsプラットフォームのみで有効です(Macintoshプラットフォームでは設定しても効果がありません)。

例: (sprite 1).silent = 1

statusText (string型、読み取り専用)

ステータス文字列として表示すべき文字列を返します。マウスカーソルの下のハイパーリンクのURLや、JavaScriptなどでステータス文字列を設定した場合に変化します。常に最新のステータス文字列を表示するには、statusTextChangeイベントハンドラを利用します。

例: put (sprite 1).statusText

スプライトメソッド

Navigate(spriteRef型 sprite, string型 URL, string型 targetName)

URLで指定したページを表示します。targetで表示するフレーム名を指定することもできます。

例: (sprite 1).Navigate("http://www.macromedia.com")
例: (sprite 1).Navigate("http://www.macromedia.com","main") 例: (sprite 1).Navigate(the moviePath & "test.html")

GoForward(spriteRef型 sprite)

次のページを表示します。

例: (sprite 1).GoForward()

GoBack(spriteRef型 sprite)

前のページを表示します。

例: (sprite 1).GoBack()

GoHome(spriteRef型 sprite)

ホームに設定されているページを表示します。Windowsプラットフォームのみで有効です(Macintoshプラットフォームでは設定しても効果がありません)。

例: (sprite 1).GoHome()

GoSearch(spriteRef型 sprite)

検索ページを表示します。

例: (sprite 1).GoSearch()

Stop(spriteRef型 sprite)

ページの読み込みを中断します。

例: (sprite 1).Stop()

Refresh(spriteRef型 sprite)

現在表示中のページをキャッシュから読み込み直します。MacintoshプラットフォームではRefresh2()と同様です。

例: (sprite 1).Refresh()

Refresh2(spriteRef型 sprite)

現在表示中のページを再度ダウンロードして表示します。

例: (sprite 1).Refresh2()

PageSetup(spriteRef型 sprite)

印刷設定ダイアログを表示します。Windowsプラットフォームのみで有効です(Macintoshプラットフォームでは設定しても効果がありません)。

例: (sprite 1).PageSetup()

PrintPreview(spriteRef型 sprite)

現在表示中のページの印刷プレビューを表示します。Windowsプラットフォームのみで有効です(Macintoshプラットフォームでは設定しても効果がありません)。

例: (sprite 1).PrintPreview()

Print(spriteRef型 sprite, integer型 setup)

現在表示中のページを印刷します。setupに0を設定すると通常通りの印刷、setupに1を設定すると印刷用ダイアログを表示、setupに2を設置すると印刷用ダイアログを表示せずに印刷します。Windowsプラットフォームのみで有効です(Macintoshプラットフォームでは設定しても効果がありません)。

例: (sprite 1).Print(0)

Save(spriteRef型 sprite)

ページ内容(html)をファイルに保存します。Windowsプラットフォームのみで有効です(Macintoshプラットフォームでは設定しても効果がありません)。アーカイブ形式、完全形式での保存や、複数フレームを含むページの保存には対応していません。

例: (sprite 1).Save("test.html")

SaveAs(spriteRef型 sprite, string型 fileName)

ページ内容(html)保存ダイアログを表示します。Windowsプラットフォームのみで有効です(Macintoshプラットフォームでは設定しても効果がありません)。アーカイブ形式、完全形式での保存や、複数フレームを含むページの保存には対応していません。

例: (sprite 1).SaveAs()

Scroll(spriteRef型 sprite, integer型 x, integer型 y)

指定した位置にウェブブラウザ画面をスクロールさせます。位置はページの左上からの絶対座標で、ピクセル単位で指定します。

例: (sprite 1).Scroll(10,20)

ScrollBy(spriteRef型 sprite, integer型 x, integer型 y)

指定した方向にウェブブラウザ画面をスクロールさせます。方向は現在位置からの相対座標で、ピクセル単位で指定します。

例: (sprite 1).ScrollBy(10,20)

MakeTextLarger(spriteRef型 sprite)

ウェブブラウザ画面の文字表示サイズを1単位大きくします。

例: (sprite 1).MakeTextLarger()

MakeTextSmaller(spriteRef型 sprite)

ウェブブラウザ画面の文字表示サイズを1単位小さくします。

例: (sprite 1).MakeTextSmaller()

SearchFor(spriteRef型 sprite, string型 keyword, integer型 forward, integer型 caseSensitive)

現在表示中のページ内で文字列を検索し、文字列が見つかればその場所までスクロールしてハイライト表示します。keywordで検索する文字列を指定します。現在の位置より下向きに検索する場合はforwardを1(true)に、上向きに検索するには0(false)に設定します。検索時に大文字・小文字を区別するにはcaseSensitiveを1(true)に、区別しない場合は0(false)に設定します。Macintoshプラットフォームのみで有効です(Windowsプラットフォームでは設定しても効果がありません)。

例: (sprite 1).SearchFor("Director",true,false)

EvalScript(spriteRef型 sprite, string型 script)

文字列で与えたスクリプト(JavaScript)を実行します。Macintoshプラットフォームでは実行結果が文字列として返ります。

例: put (sprite 1).EvalScript("return confirm('continue?');")

SetFocus(spriteRef型 sprite)

このスプライトにフォーカスを設定します。

例: (sprite 1).SetFocus()

UnsetFocus(spriteRef型 sprite)

このスプライトからフォーカスを解除します。Macintoshプラットフォームのみで有効です(Windowsプラットフォームでは設定しても効果がありません)。

例: (sprite 1).UnsetFocus()

Show(spriteRef型 sprite)

このスプライトをステージ上に表示します。

例: (sprite 1).Show()

Hide(spriteRef型 sprite)

このスプライトをステージ上から非表示にします。

例: (sprite 1).Hide()

スプライトイベントハンドラ

BeforeNavigate2(spriteRef型 sprite, string型 URL, sring型 target)

新しいページを読み込もうとする際に呼び出されます。URLで新しいページのURL、targetで読み込み先のフレーム名を取得できます。

例:
on BeforeNavigate2 me, newURL, newTtarget
    put "BeforeNaigate2" && newURL&& newTarget
end

NavigateForwardStateChange(spriteRef型 sprite, integer型 enable)

次のページへ進むことができるようになった場合、またはできなくなった場合に呼び出されます。ブラウザの[次へ]ボタンの有効化・無効化の設定に使うと便利です。enableが1(true)の場合は次のページへ進むことが可能、0(false)の場合は不可能になったことがわかります。

例:
on NavigateForwardStateChange me, nextEnable
    if nextEnable = true then
        (sprite 10).locV = 16  -- 'Next' button sprite 
    else
        (sprite 10).locV = -1000
    end if
end

NavigateBackStateChange(spriteRef型 sprite, integer型 enable)

前のページへ戻ることができるようになった場合、またはできなくなった場合に呼び出されます。ブラウザの[前へ]ボタンの有効化・無効化の設定に使うと便利です。enableが1(true)の場合は前のページへ戻ることが可能、0(false)の場合は不可能になったことがわかります。

例:
on NavigateBackStateChange me, backEnable
    if backEnable = true then
        (sprite 11).locV = 16  -- 'Back' button sprite 
    else
        (sprite 11).locV = -1000
    end if
end

TextLargerStateChange(spriteRef型 sprite, integer型 enable)

ウェブブラウザ画面の文字表示サイズを1単位大きくできるようになった場合、またはできなくなった場合に呼び出されます。ブラウザの[文字を大きく]ボタンの有効化・無効化の設定に使うと便利です。enableが1(true)の場合は文字サイズを大きくすることが可能、0(false)の場合は不可能になったことがわかります。

例:
on TextLargerStateChange me, largerEnable
    if largerEnable = true then
        (sprite 12).locV = 16  -- 'Larger font' button sprite 
    else
        (sprite 12).locV = -1000
    end if
end

TextSmallerStateChange(spriteRef型 sprite, integer型 enable)

ウェブブラウザ画面の文字表示サイズを1単位小さくできるようになった場合、またはできなくなった場合に呼び出されます。ブラウザの[文字を小さく]ボタンの有効化・無効化の設定に使うと便利です。enableが1(true)の場合は文字サイズを小さくすることが可能、0(false)の場合は不可能になったことがわかります。

例:
on TextSmallerStateChange me, smallerEnable
if smallerEnable = true then
(sprite 13).locV = 16 -- 'Smaller font' button sprite
else
(sprite 13).locV = -1000
end if
end

DocumentComplete(spriteRef型 sprite)

ページの読み込みが完了した場合に呼び出されます。readyStateプロパティが4になります。

例:
on DocumentComplete me
    put "DocumentComplete"
end

DownloadBegin(spriteRef型 sprite)

ダウンロードが開始された時に呼び出されます。busyプロパティが1(true)になります。

例:
on DownloadBegin me
    put "DownloadBegin"
end

DownloadComplete(spriteRef型 sprite)

ダウンロードが終了した時に呼び出されます。busyプロパティが0(false)になります。

例:
on DownloadComplete me
    put "DownloadComplete"
end

FileDownload(spriteRef型 sprite)

ファイルのダウンロードが開始された時に呼び出されます。

例:
on FileDownload me
    put "FileDownload"
end

NavigateComplete2(spriteRef型 sprite)

新しいページが表示された時に呼び出されます。

例:
on NavigationComplete2 me
    put "NavigationComplete2"
end

NavigateError(spriteRef型 sprite, string型 URL, string型 target, integer型 statusCode)

ページの読み込み中にエラーが発生した場合に呼び出されます。URLでエラーの起きたページのURL、targetで読み込み先のフレーム名を取得できます。statusCodeはエラーの内容を表します。エラーの詳細についてはこちらを参照して下さい。

例:
on NavigateError me, newURL, newTarget, statusCode
    put "NavigateError" && string(statusCode) && "at" && newURL && "(" & newTarget & ")"
end

NewWindow2(spriteRef型 sprite, string型 URL, string型 target)

新しいウェブブラウザウィンドウを開こうとする際に呼び出されます。新しいページは現在のウェブブラウザ画面に読み込まれます。

例:
on NewWindow2 me, newURL, newTarget
    put "NewWindow2" && newURL&& newTarget
end

ProgressChange(spriteRef型 sprite, integer型 progress, integer型 progressMax)

ページの読み込み中に進行状態を定期的に通知します。progressMax個の全読み込みファイル中、progress個のファイルが読み込まれたことを表します。

例:
on ProgressChange me, progress, progressMax
    put "Loading..." && string(progress) && "/" && string(progressMax)
end

StatusTextChange(spriteRef型 sprite, string型 statusText)

ステータス文字列が変化した際に呼び出されます。statusText で新しいステータス文字列を取得できます。

例:
on StatusTextChange me, statusText
    (member "StatusText").text = statusText
end

TitleChange(spriteRef型 sprite, string型 title)

ページタイトルが変化した際に呼び出されます。title で新しいページタイトル文字列を取得できます。

例:
on TitleChange titleText me
    (member "TitleText").text = titleText
end

現在見つかっている問題点

Windows環境

Macintosh環境

バージョン変更履歴

Version 1.5.1

Version 1.5

Version 1.4

Version 1.3

Version 1.2

Version 1.1

Version 1.0

最初のリリースバージョン。

 


Last updated: 2004-08-21