パッケージ com.osboffice.osbxl

クラス AutoFilterWrapper

java.lang.Object
com.osboffice.osbxl.AutoFilterWrapper
public class AutoFilterWrapper extends Object
オートフィルターを扱うクラスです。ワークシートまたは、テーブルから使用します。

  • メソッドの詳細

    • getAddress

      public String getAddress()
      オートフィルターの対象セル範囲を取得します。
      戻り値:
      対象セル範囲(A1C1)

    • getSort

      public SortWrapper getSort()
      並び替えクラスを取得します。
      戻り値:
      並び替えクラス

    • setFontColorFilter

      public void setFontColorFilter(String targetA1, int colId)
      FontColorFilter(フォント色によるフィルター)の設定を行います。
      1. パラメータ`targetA1`のセルのフォント色をフィルター条件に加えます。このパラメータが空値の場合、フォント色は自動となります。
      パラメータ:
      targetA1 - 対象セル
      colId - フィルター対象列 (先頭列=1)

    • setFontColorFilter

      public void setFontColorFilter(String targetA1)
      FontColorFilter(フォント色によるフィルター: 先頭列)の設定を行います。
      1. パラメータ`targetA1`のセルのフォント色をフィルター条件に加えます。このパラメータが空値の場合、フォント色は自動となります。
      パラメータ:
      targetA1 - 対象セル

    • setCellColorFilter

      public void setCellColorFilter(String targetA1, int colId)
      CellColorFilter(セル色によるフィルター)の設定を行います。
      1. パラメータ`targetA1`のセルのセル色をフィルター条件に加えます。このパラメータが空値の場合、セル色は、自動となります。
      パラメータ:
      targetA1 - 対象セル
      colId - フィルター対象列 (先頭列=1)

    • setCellColorFilter

      public void setCellColorFilter(String targetA1)
      CellColorFilter(セル色によるフィルター: 先頭列)の設定を行います。
      1. パラメータ`targetA1`のセルのセル色をフィルター条件に加えます。このパラメータが空値の場合、セル色は、自動となります。
      パラメータ:
      targetA1 - 対象セル

    • setIconFilter

      public void setIconFilter(XlFilterIconSet filterIconset, int filterIconId, int colId)
      IconFilter(表示アイコンによるフィルター)の設定を行います。
      1. パラメータ`filterIconId`は、パラメータ`filterIconset'のアイコンの中で、何番目のアイコンをフィルター対象にするかどうかを設定します。
      パラメータ:
      filterIconset - アイコンセット アイコンセットなしに設定する場合は、XlFilterIconSet.IconSetNoneを設定します。
      filterIconId - アイコンセットの中のアイコンID 1から始まります。アイコンセットなしに設定する場合は任意の値となります。
      colId - フィルター対象列 (先頭列=1)

    • setIconFilter

      public void setIconFilter(XlFilterIconSet filterIconset, int filterIconId)
      IconFilter(表示アイコンによるフィルター: 先頭列)の設定を行います。
      1. パラメータ`filterIconId`は、パラメータ`filterIconset'のアイコンの中で、何番目のアイコンをフィルター対象にするかどうかを設定します。
      パラメータ:
      filterIconset - アイコンセット アイコンセットなしに設定する場合は、XlFilterIconSet.IconSetNoneを設定します。
      filterIconId - アイコンセットの中のアイコンID 1から始まります。アイコンセットなしに設定する場合は任意の値となります。

    • setDateTimeFilter

      public void setDateTimeFilter(XlAutoFilterDateTime filterVal, int colId)
      DateTimeFilter(表示日時によるフィルター)の設定を行います。
      1. パラメータ`filterVal`の単位をフィルター条件に設定します。
      パラメータ:
      filterVal - 日付のグルーピング単位
      colId - フィルター対象列 (先頭列=1)

    • setDateTimeFilter

      public void setDateTimeFilter(XlAutoFilterDateTime filterVal)
      DateTimeFilter(表示日時によるフィルター: 先頭列)の設定を行います。
      1. パラメータ`filterVal`の単位をフィルター条件に設定します。
      パラメータ:
      filterVal - 日付のグルーピング単位

    • setTop10ValueFilter

      public void setTop10ValueFilter(int filterVal, int colId)
      Top10ValueFilter(値の上位の値フィルター)の設定を行います。
      1. 上位`filterVal`件がフィルター条件となります。
      パラメータ:
      filterVal - フィルター値
      colId - フィルター対象列 (先頭列=1)

    • setTop10ValueFilter

      public void setTop10ValueFilter(int filterVal)
      Top10ValueFilter(値の上位の値フィルター: パーセント)の設定を行います。
      1. 上位`filterVal`件がフィルター条件となります。
      パラメータ:
      filterVal - フィルター値

    • setTop10PercentFilter

      public void setTop10PercentFilter(int filterVal, int colId)
      Top10PercentFilter(値の上位のパーセント値フィルター)の設定を行います。
      1. 上位`filterVal`パーセントがフィルター条件となります。
      パラメータ:
      filterVal - フィルター値(パーセント値: 0～100)
      colId - フィルター対象列 (先頭列=1)

    • setTop10PercentFilter

      public void setTop10PercentFilter(int filterVal)
      Top10PercentFilter(値の上位のパーセント値フィルター: 先頭列)の設定を行います。
      1. 上位`filterVal`パーセントがフィルター条件となります。
      パラメータ:
      filterVal - フィルター値(パーセント値: 0～100)

    • setBottom10ValueFilter

      public void setBottom10ValueFilter(int filterVal, int colId)
      Bottom10ValueFilter(値の下位の値フィルター)の設定を行います。
      1. 下位`filterVal`件がフィルター条件となります。
      パラメータ:
      filterVal - フィルター値
      colId - フィルター対象列 (先頭列=1)

    • setBottom10ValueFilter

      public void setBottom10ValueFilter(int filterVal)
      Bottom10ValueFilter(値の下位の値フィルター: 先頭列)の設定を行います。
      1. 下位`filterVal`件がフィルター条件となります。
      パラメータ:
      filterVal - フィルター値

    • setBottom10PercentFilter

      public void setBottom10PercentFilter(int filterVal, int colId)
      BottomPercentFilter(値の下位のパーセント値フィルター)の設定を行います。
      1. 下位`filterVal`パーセントがフィルター条件となります。
      パラメータ:
      filterVal - フィルター値(パーセント値: 0～100)
      colId - フィルター対象列 (先頭列=1)

    • setBottom10PercentFilter

      public void setBottom10PercentFilter(int filterVal)
      BottomPercentFilter(値の下位のパーセント値フィルター: 先頭列)の設定を行います。
      1. 下位`filterVal`パーセントがフィルター条件となります。
      パラメータ:
      filterVal - フィルター値(パーセント値: 0～100)

    • setUniqueValuesNumberFilter

      public void setUniqueValuesNumberFilter(List<Double> filterVals, int colId)
      UniqueValueFilter(値(数値)の一意性によるフィルター)の設定を行います。
      1. パラメータ`filterVals`は、複数値設定可能です。セルの値が数値であるセルがフィルター対象です。
      パラメータ:
      filterVals - List＜フィルター対象数値＞
      colId - フィルター対象列 (先頭列=1)

    • setUniqueValuesNumberFilter

      public void setUniqueValuesNumberFilter(List<Double> filterVals)
      UniqueValueFilter(値(数値)の一意性によるフィルター: 先頭列)の設定を行います。
      1. パラメータ`filterVals`は、複数値設定可能です。セルの値が数値であるセルがフィルター対象です。
      パラメータ:
      filterVals - List＜フィルター対象数値＞

    • setUniqueValuesStringFilter

      public void setUniqueValuesStringFilter(List<String> filterVals, int colId)
      UniqueValueFilter(値(文字列)の一意性によるフィルター)の設定を行います。
      1. パラメータ`filterVals`は、複数値設定可能です。セルの値が文字列であるセルがフィルター対象です。
      パラメータ:
      filterVals - List＜フィルター対象文字列＞
      colId - int フィルター対象列 (先頭列=1)

    • setUniqueValuesStringFilter

      public void setUniqueValuesStringFilter(List<String> filterVals)
      UniqueValueFilter(値(文字列)の一意性によるフィルター: 先頭列)の設定を行います。
      1. パラメータ`filterVals`は、複数値設定可能です。セルの値が文字列であるセルがフィルター対象です。
      パラメータ:
      filterVals - List＜フィルター対象文字列＞

    • setUniqueValuesDateTimeFilter

      public void setUniqueValuesDateTimeFilter(List<DateTimeObjectWrapper> filterVals, int colId)
      UniqueValueFilter(値(日付/時刻オブジェクト)の一意性によるフィルター)の設定を行います。
      1. パラメータ`filterVals`は、複数値設定可能です。セルの値が日付/時刻であるセルがフィルター対象です。
      パラメータ:
      filterVals - List＜フィルター対象日付/時刻オブジェクト＞
      colId - フィルター対象列 (先頭列=1)

    • setUniqueValuesDateTimeFilter

      public void setUniqueValuesDateTimeFilter(List<DateTimeObjectWrapper> filterVals)
      UniqueValueFilter(値(日付/時刻オブジェクト)の一意性によるフィルター: 先頭列)の設定を行います。
      1. パラメータ`filterVals`は、複数値設定可能です。セルの値が日付/時刻であるセルがフィルター対象です。
      パラメータ:
      filterVals - List＜フィルター対象日付/時刻オブジェクト＞

    • setDateTimeGroupingFilter

      public void setDateTimeGroupingFilter(List<DateTimeObjectWrapper> filterVals, List<XlDateTimeGroupingType> filterTypes, int colId)
      DateTimeGroupingFilter(表示日時(複数)によるフィルター)の設定を行います。
      1. パラメータ`filterVals`は、複数値設定可能です。セルの値が日付/時刻であるセルがフィルター対象です。
      2. パラメータ`filterTypes`は、複数値設定可能です。グルーピングの単位を指定します。
      3. パラメータ`filterVals`の数とパラメータ`filterTypes`の数は、同じである必要があります。n番目の`filterVals`の値をn番目の`filterTypes`の条件でフィルター条件とします。
      パラメータ:
      filterVals - List＜フィルター対象日付/時刻オブジェクト＞
      filterTypes - List＜グルーピング単位＞
      colId - フィルター対象列 (先頭列=1)

    • setDateTimeGroupingFilter

      public void setDateTimeGroupingFilter(List<DateTimeObjectWrapper> filterVals, List<XlDateTimeGroupingType> filterTypes)
      DateTimeGroupingFilter(表示日時(複数)によるフィルター: 先頭列)の設定を行います。
      1. パラメータ`filterVals`は、複数値設定可能です。セルの値が日付/時刻であるセルがフィルター対象です。
      2. パラメータ`filterTypes`は、複数値設定可能です。グルーピングの単位を指定します。
      3. パラメータ`filterVals`の数とパラメータ`filterTypes`の数は、同じである必要があります。n番目の`filterVals`の値をn番目の`filterTypes`の条件でフィルター条件とします。
      パラメータ:
      filterVals - List＜フィルター対象日付/時刻オブジェクト＞
      filterTypes - List＜グルーピング単位＞

    • setAverageFilter

      public void setAverageFilter(boolean aboveAverage, int colId)
      averageFilter(平均値によるフィルター)の設定を行います。
      1. パラメータ`aboveAverage`が、trueは平均以上、falseは平均以下が、フィルター対象となります。
      パラメータ:
      aboveAverage - true: 平均値以上 false: 平均値以下
      colId - フィルター対象列 (先頭列=1)

    • setAverageFilter

      public void setAverageFilter(boolean aboveAverage)
      averageFilter(平均値によるフィルター: 先頭列)の設定を行います。
      1. パラメータ`aboveAverage`が、trueは、平均以上、falseは、平均以下が、フィルター対象となります。
      パラメータ:
      aboveAverage - true: 平均値以上 false: 平均値以下

    • setCustomFilter

      public void setCustomFilter(XlAutoFilterOperator op, String criteria, int colId)
      CustomFilter(ワイルドカード含む任意条件のフィルター)の設定を行います。
      1. 任意条件のフィルターを設定します。パラメータ`criteria`には、*,? 等を含む条件式が入力可能です。(Excelと同一です)
      パラメータ:
      op - 演算子
      criteria - 検索条件
      colId - フィルター対象列 (先頭列=1)

    • setCustomFilter

      public void setCustomFilter(XlAutoFilterOperator op, String criteria)
      CustomFilter(ワイルドカード含む任意条件のフィルター: 先頭列)の設定を行います。
      1. 任意条件のフィルターを設定します。パラメータ`criteria`には、*,? 等を含む条件式が入力可能です。(Excelと同一です)
      パラメータ:
      op - 演算子
      criteria - 検索条件

    • setAndCustomFilter

      public void setAndCustomFilter(XlAutoFilterOperator op1, String criteria1, XlAutoFilterOperator op2, String criteria2, int colId)
      AndCustomFilter(ワイルドカード含む任意条件のフィルター(2条件をAndで結合))の設定を行います。
      1. パラメータ`criteria1`,パラメータ`criteria2`には、*,? 等を含む条件式が入力可能です。(Excelと同一です)
      パラメータ:
      op1 - 演算子
      criteria1 - 検索条件1
      op2 - 演算子
      criteria2 - 検索条件2
      colId - フィルター対象列 (先頭列=1)

    • setAndCustomFilter

      public void setAndCustomFilter(XlAutoFilterOperator op1, String criteria1, XlAutoFilterOperator op2, String criteria2)
      AndCustomFilter(ワイルドカード含む任意条件のフィルター(2条件をAndで結合): 先頭列)の設定を行います。
      1. パラメータ`criteria1`,パラメータ`criteria2`には、*,? 等を含む条件式が入力可能です。(Excelと同一です)
      パラメータ:
      op1 - 演算子
      criteria1 - 検索条件1
      op2 - 演算子
      criteria2 - 検索条件2

    • setOrCustomFilter

      public void setOrCustomFilter(XlAutoFilterOperator op1, String criteria1, XlAutoFilterOperator op2, String criteria2, int colId)
      OrCustomFilter(ワイルドカード含む任意条件のフィルター(2条件をOrで結合))の設定を行います。
      1. パラメータ`criteria1`,パラメータ`criteria2`には、*,? 等を含む条件式が入力可能です。(Excelと同一です)
      パラメータ:
      op1 - 演算子
      criteria1 - 検索条件1
      op2 - 演算子
      criteria2 - 検索条件2
      colId - フィルター対象列 (先頭列=1)

    • setOrCustomFilter

      public void setOrCustomFilter(XlAutoFilterOperator op1, String criteria1, XlAutoFilterOperator op2, String criteria2)
      OrCustomFilter(ワイルドカード含む任意条件のフィルター(2条件をOrで結合): 先頭列)の設定を行います。
      1. パラメータ`criteria1`,パラメータ`criteria2`には、*,? 等を含む条件式が入力可能です。(Excelと同一です)
      パラメータ:
      op1 - 演算子
      criteria1 - 検索条件1
      op2 - 演算子
      criteria2 - 検索条件2

    • resetFilter

      public void resetFilter(int colId)
      オートフィルター条件のクリアを行います。
      パラメータ:
      colId - 条件削除対象列 (先頭列=1)

    • resetAllFilter

      public void resetAllFilter()
      オートフィルター条件の全クリアを行います。オートフィルター自体は残ります。

    • removeFilter

      public void removeFilter()
      オートフィルターの削除を行います。オートフィルター自体を削除します。