org.seasar.s2click.page
クラス AbstractDownloadPage

java.lang.Object
  上位を拡張 net.sf.click.Page
      上位を拡張 org.seasar.s2click.page.AbstractDownloadPage

推奨されていません。 このクラスは将来のバージョンで削除される可能性があります。

public abstract class AbstractDownloadPage
extends net.sf.click.Page

ファイルをダウンロードするページのための抽象基底クラスです。

以下に実装例を示します:

 public SampleDownloadPage extends AbstractDownloadPage {
   public SampleDownloadPage(){
     setFileName("sample.txt");
     setContents(SampleDownloadPage.class.getResourceAsStream("sample.txt"));
   }
 }
ファイルダウンロードページはダウンロードするコンテンツを自分自身でレスポンスに書き込むため、HTMLテンプレートは不要です。 ただし、ClickはHTMLテンプレートが存在しないページクラスは自動マッピングの対象外となるため、 クラスにPathアノテーションを付与することでパスを明示するとよいでしょう。

作成者:
Naoki Takezoe

フィールドの概要
protected  java.lang.String contentDisposition
          推奨されていません。  
protected  java.io.InputStream contents
          推奨されていません。  
protected  java.lang.String contentType
          推奨されていません。  
protected  java.lang.String fileName
          推奨されていません。  
 
クラス net.sf.click.Page から継承されたフィールド
controls, format, forward, headers, headersEdited, messages, model, PAGE_MESSAGES, path, redirect, stateful
 
コンストラクタの概要
AbstractDownloadPage()
          推奨されていません。  
 
メソッドの概要
 java.lang.String getContentType()
          推奨されていません。  
 java.lang.String getPath()
          推奨されていません。 ファイルダウンロードページではHTMLテンプレートが不要であるため、 このメソッドは常にnullを返すよう実装されています。
 void onRender()
          推奨されていません。 このメソッド内でダウンロードコンテンツをレスポンスに書き出します。
protected  void setContentDisposition(java.lang.String contentDisposition)
          推奨されていません。 Content-Dispositionヘッダの値をセットします。
protected  void setContents(java.io.InputStream contents)
          推奨されていません。 ダウンロードするコンテンツのInputStreamをセットします。
protected  void setContentType(java.lang.String contentType)
          推奨されていません。 Content-Typeヘッダの値を設定します。
protected  void setFileName(java.lang.String fileName)
          推奨されていません。 ダウンロードファイル名をセットします。
 
クラス net.sf.click.Page から継承されたメソッド
addControl, addModel, getContext, getControls, getFormat, getForward, getHeaders, getMessage, getMessage, getMessage, getMessages, getModel, getRedirect, getTemplate, hasControls, isStateful, onDestroy, onGet, onInit, onPost, onSecurityCheck, setFormat, setForward, setForward, setForward, setHeader, setHeaders, setPath, setRedirect, setRedirect, setStateful
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

フィールドの詳細

contentType

protected java.lang.String contentType
推奨されていません。 

contentDisposition

protected java.lang.String contentDisposition
推奨されていません。 

fileName

protected java.lang.String fileName
推奨されていません。 

contents

protected java.io.InputStream contents
推奨されていません。 
コンストラクタの詳細

AbstractDownloadPage

public AbstractDownloadPage()
推奨されていません。 
メソッドの詳細

setContentType

protected void setContentType(java.lang.String contentType)
推奨されていません。 
Content-Typeヘッダの値を設定します。

パラメータ:
contentType - コンテンツタイプ。 デフォルト値は"application/octet-stream"です。

getContentType

public java.lang.String getContentType()
推奨されていません。 
オーバーライド:
クラス net.sf.click.Page 内の getContentType

setFileName

protected void setFileName(java.lang.String fileName)
推奨されていません。 
ダウンロードファイル名をセットします。

パラメータ:
fileName - ファイル名

setContents

protected void setContents(java.io.InputStream contents)
推奨されていません。 
ダウンロードするコンテンツのInputStreamをセットします。

パラメータ:
contents - ダウンロードするコンテンツ

setContentDisposition

protected void setContentDisposition(java.lang.String contentDisposition)
推奨されていません。 
Content-Dispositionヘッダの値をセットします。

パラメータ:
contentDisposition - "attachment"もしくは"inline"。 デフォルト値は"attachment"です。

getPath

public java.lang.String getPath()
推奨されていません。 
ファイルダウンロードページではHTMLテンプレートが不要であるため、 このメソッドは常にnullを返すよう実装されています。

オーバーライド:
クラス net.sf.click.Page 内の getPath

onRender

public void onRender()
推奨されていません。 
このメソッド内でダウンロードコンテンツをレスポンスに書き出します。

オーバーライド:
クラス net.sf.click.Page 内の onRender