クラス FileOptionTag

すべての実装されたインタフェース:
BodyTag, IterationTag, JspTag, Tag, TryCatchFinally, Serializable

public class FileOptionTag extends CommonTagSupport
ファイルのプルダウンリストの作成するタグです。 SelectタグのBODY部に指定します。 並び替えについては、このタグで指定しますが、ファイルの選別は、 BODY 部に記述する fileWhere タグで指定します。
関連項目:
変更履歴:
2.1.1.0 (2002/11/11) 新規作成, 4.0.0.0 (2005/01/31) 内部ロジック改定
機能分類
その他入力
形式サンプル:
●形式:<og:fileOption from="…" value="[…]" ・・・ >・・・</og:fileOption> ●body:あり(EVAL_BODY_BUFFERED:BODYを評価し、{@XXXX} を解析します) ●Tag定義: <og:fileOption from 【TAG】ファイルの検索元となるディレクトリを指定します (初期値:FILE_URL[=filetemp/]) value 【TAG】Optionの初期値で選ばれる値を指定します nameOnly 【TAG】ファイルの拡張子を除いた名前部分のみの値で行います。7.2.4.0 (2020/05/11) groupDir 【TAG】optgroupを、ディレクトリの値で作成します(1レベルのみ)。 orderBy 【TAG】検索した結果を表示する表示順をファイル属性名で指定します(初期値:自然順序) desc 【TAG】表示順を逆転するかどうか[true/false]を指定します(初期値:false) useLocal 【TAG】システム定数でクラウド設定されていても、クラウド環境を使用しない場合、trueを指定します(初期値:false) 8.0.1.0 (2021/10/29) caseKey 【TAG】このタグ自体を利用するかどうかの条件キーを指定します(初期値:null) 6.8.0.0 (2017/06/02) caseVal 【TAG】このタグ自体を利用するかどうかの条件値を指定します(初期値:null) 6.8.0.0 (2017/06/02) caseNN 【TAG】指定の値が、null/ゼロ文字列 でない場合(Not Null=NN)は、このタグは使用されます(初期値:判定しない) 6.8.0.0 (2017/06/02) caseNull 【TAG】指定の値が、null/ゼロ文字列 の場合は、このタグは使用されます(初期値:判定しない) 6.8.0.0 (2017/06/02) caseIf 【TAG】指定の値が、true/TRUE文字列の場合は、このタグは使用されます(初期値:判定しない) 6.8.0.0 (2017/06/02) debug 【TAG】デバッグ情報を出力するかどうか[true/false]を指定します(初期値:false) X useDir 【廃止】(廃止:7.2.6.0 (2020/06/30))optionリストの作成を、ディレクトリの値で行います。 > ... Body ... </og:fileOption> ●使用例 <og:fileOption val1="ABCD" val2="{@value}" > <og:fileWhere startsWith="ABCD" ・・・ /> </og:fileOption>
導入されたバージョン:
JDK5.0,
  • コンストラクタの詳細

    • FileOptionTag

      public FileOptionTag()
      デフォルトコンストラクター
      変更履歴:
      6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor.
  • メソッドの詳細

    • doStartTag

      public int doStartTag()
      Taglibの開始タグが見つかったときに処理する doStartTag() を オーバーライドします。
      定義:
      doStartTag インタフェース内 Tag
      オーバーライド:
      doStartTag クラス内 CommonTagSupport
      戻り値:
      後続処理の指示( EVAL_BODY_BUFFERED )
      変更履歴:
      6.8.0.0 (2017/06/02) caseKey,caseVal,caseNN,caseNull 属性を追加
    • doAfterBody

      public int doAfterBody()
      Taglibのタグ本体を処理する doAfterBody() を オーバーライドします。
      定義:
      doAfterBody インタフェース内 IterationTag
      オーバーライド:
      doAfterBody クラス内 CommonTagSupport
      戻り値:
      後続処理の指示(SKIP_BODY)
    • doEndTag

      public int doEndTag()
      Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。
      定義:
      doEndTag インタフェース内 Tag
      オーバーライド:
      doEndTag クラス内 CommonTagSupport
      戻り値:
      後続処理の指示
      変更履歴:
      3.1.1.2 (2003/04/04) Tomcat4.1 対応。release2() を doEndTag()で呼ぶ。, 6.3.4.0 (2015/08/01) useDir 属性と、groupDir 属性 を追加します。, 6.8.0.0 (2017/06/02) caseKey,caseVal,caseNN,caseNull 属性を追加, 8.0.0.1 (2021/10/08) cloud対応
    • release2

      protected void release2()
      タグリブオブジェクトをリリースします。 キャッシュされて再利用されるので、フィールドの初期設定を行います。
      オーバーライド:
      release2 クラス内 CommonTagSupport
      変更履歴:
      3.1.1.2 (2003/04/04) Tomcat4.1 対応。release2() を doEndTag()で呼ぶ。, 6.3.4.0 (2015/08/01) useDir 属性と、groupDir 属性 を追加します。, 7.2.4.0 (2020/05/11) nameOnly 属性 を追加します。, 7.2.6.0 (2020/06/30) ディレクトリ処理を統一します。, 8.0.1.0 (2021/10/29) useLocal 属性を追加。
    • setValue

      public void setValue(String val)
      【TAG】Optionの初期値で選ばれる値を指定します。
      パラメータ:
      val - 初期値で選ばれる値
      説明:
      キーになるのは、ファイル属性の NAME です。(ディレクトリなしのファイル名) ここで value属性に指定した場合、このファイル名と(大文字小文字を無視して) 一致する場合に、プルダウンの初期値に表示されます。(selected 属性が設定される。)
    • setUseDir

      public void setUseDir(String flag)
      【廃止】optionリストの作成を、ディレクトリの値で行います(初期値:false)。
      パラメータ:
      flag - ディレクトリ名のリストで、オプションを作成するかどうか [true:ディレクトリ/false:ファイル]
      変更履歴:
      6.3.4.0 (2015/08/01) useDir 属性の追加, 7.2.6.0 (2020/06/30) ディレクトリ処理を統一します。
      説明:
      ファイル検索で、ディレクトリ名のリストで、オプションを作成します。 初期値は、false(ファイル名でリスト)です。
    • setNameOnly

      public void setNameOnly(String flag)
      【TAG】ファイルの拡張子を除いた名前部分のみの値で行います(初期値:false)。
      パラメータ:
      flag - ファイルの拡張子を除いた名前部分のみで、オプションを作成するかどうか [true:名前部分のみ/false:ファイル名]
      変更履歴:
      7.2.4.0 (2020/05/11) nameOnly 属性 を追加します。
      説明:
      ファイル検索の値を、ファイルの拡張子を取り除いた値のみで、オプションを作成します。 初期値は、false(拡張子付きファイル名でリスト)です。
    • setGroupDir

      public void setGroupDir(String flag)
      【TAG】optgroupを、ディレクトリの値で作成します(1レベルのみ)(初期値:false)。
      パラメータ:
      flag - ディレクトリで階層メニューを作成するかどうか [true:階層/false:通常]
      変更履歴:
      6.3.4.0 (2015/08/01) groupDir 属性の追加
      説明:
      optgroupをディレクトリで作成することで、階層のメニューを作成します。 初期値は、false(通常) です。
    • setFrom

      public void setFrom(String url)
      【TAG】ファイルの検索元となるディレクトリを指定します (初期値:FILE_URL[=])。
      パラメータ:
      url - ファイルの検索元となるディレクトリ
      関連項目:
      変更履歴:
      4.0.0.0 (2007/11/20) 指定されたディレクトリ名の最後が"\"or"/"で終わっていない場合に、"/"を付加する。, 6.4.2.1 (2016/02/05) URLの最後に、"/" を追加する処理を廃止。, 6.4.2.1 (2016/02/05) HybsSystem.url2dir に引数追加。
      説明:
      ファイルの検索元となるディレクトリを指定します。 (初期値:システム定数のFILE_URL[=])。
    • setOrderBy

      public void setOrderBy(String ordr)
      【TAG】検索した結果を表示する表示順をファイル属性名[null/NAME/LASTMODIFIED/FILE_LENGTH]で指定します(初期値:自然順序)。
      パラメータ:
      ordr - ソートキー [null/NAME/LASTMODIFIED/FILE_LENGTH]
      変更履歴:
      3.5.6.2 (2004/07/05) 文字列の連結にStringBuilderを使用します。, 4.0.0.0 (2005/01/31) 新規ロジックで改定, 5.3.4.0 (2011/04/01) ORDER_BYリストの出力方法 見直し, 6.3.4.0 (2015/08/01) Arrays.toString から String.join に置き換え。, 6.4.3.4 (2016/03/11) String配列 から、Setに置き換えます。
      説明:
      ファイルをソートする順(Comparator)を指定します。ソートに指定できる ファイル属性名は、"NAME","LASTMODIFIED","FILE_LENGTH" の内のどれかひとつです。 何も指定しない場合は、Fileオブジェクトの自然順序でのソートになります。 (※ 下位互換性のため、LENGTH も残しますが、廃止予定です。)
    • setDesc

      public void setDesc(String flag)
      【TAG】表示順を逆転するかどうか[true/false]を指定します(初期値:false)。
      パラメータ:
      flag - 表示順を逆転するかどうか [true:逆順/false:昇順]
      説明:
      orderBy 属性で指定した表示順を、逆順にするかどうかを指定できます。 初期値は、false(昇順)です。
    • setUseLocal

      public void setUseLocal(String flag)
      【TAG】システム定数でクラウド設定されていても、クラウド環境を使用しない場合、trueを指定します(初期値:false)。
      パラメータ:
      flag - ローカル環境のみ [true:ローカルのみ/false:設定どおり]
      変更履歴:
      8.0.1.0 (2021/10/29) useLocal 属性を追加。
      説明:
      クラウド設定は、システム定数の『CLOUD_TARGET』と『CLOUD_BUCKET』の設定で自動的に使用しますが、 どうしてもローカルでのみ使いたい場合は、この属性を true に設定します。 標準はfalse:設定どおりとなります。 true/false以外を指定した場合はfalse扱いとします。
    • setFileFilter

      protected void setFileFilter(FileFilter filter)
      FileFilterオブジェクトをセットします。 これは、BODY 部に登録した、FileWhereタグによって設定された ファイルフィルターです。
      パラメータ:
      filter - オブジェクト
    • toString

      public String toString()
      このオブジェクトの文字列表現を返します。 基本的にデバッグ目的に使用します。
      オーバーライド:
      toString クラス内 CommonTagSupport
      戻り値:
      このクラスの文字列表現
      このメソッドは、nullを返しません