iframeコンポーネントはHTML IFRAMEタグを使用して、画面の一部を他のURLの内容に代替表示させます。includeコンポーネントに類似しているように見えますが、そのコンセプトは全然違います。

includeコンポーネントによって含まれているコンテンツはHTMLページのフラグメントです。そのコンテンツはHTMLページの一部分なので、コンテンツはデスクトップの一部でincludeコンポーネントの中のどのコンポーネントへもアクセスできます。include作業はサーバーで行われ、ブラウザはそれについて何の情報もないです。つまり、srcプロパティによって指定されたURLはどんな内部のリソースでも構いません。

iframeコンポーネントのコンテンツはブラウザによって、異なった一つのページとして、読み込まれます。独立したページとして読み込まれるので、コンテンツのフォーマットはHTMLと異なっています。例えばPDFファイルを埋め込むことができます。

<iframe src="/my.pdf"/>
...other HTML content

【ヒント】：デフォルトではボーダー(枠)はありません。ボーダーを使うには、スタイル属性を使用して指定します。例えば、<iframe style="border:1px inset" src="http://www.zkoss.org"/>

その埋め込みはIFRAMEタグを含んだHTMLページをインタープリットするときにブラウザによって行われます。つまり、そのURLはブラウザからアクセスできるリソースでなければなりません。

imageとaudioコンポーネント[48]のように、動的に生成されたコンテンツを指定できます。代表的な例はJasperReport[49]を使用して、バイナリ配列またはシステムの中でPDFレポートを生成します。レポートをorg.zkoss.util.media.Amediaクラスを使って結果をまとめて、iframeコンポーネントに報告します。

以下の例中では、クライアントがそのフォーマットをサポートする限り、iframeの使用によりどのコンテンツも埋め込むことができます。

<window title="iframe demo" border="normal">
    <iframe id="iframe" width="95%"/>    
    <separator bar="true"/>    
    <button label="Upload">    
        <attribute name="onClick">{        
            Object media = Fileupload.get();            
            if (media != null)            
                iframe.setContent(media);                
        }</attribute>        
    </button>    
</window>

この画像はユーザーがマイクロソフトのパワーポイントファイルをアップロードした後の画像です。

//Part of your, say, PHP page
<script type="text/script">
function onIframeChange(uuid, url) {
    do_whatever_you_need_in_the_technology_you_use(uuid, url);    
}
</script>