パッケージ com.osboffice.osbxl

クラス FormatConditionsWrapper

java.lang.Object
com.osboffice.osbxl.FormatConditionsWrapper
public class FormatConditionsWrapper extends Object
条件付き書式を扱うクラスです。ワークシートから使用します。

osbxlでは、各種条件(複数可)を設定後、apply()メソッドを呼び計算を反映させる必要があります。 apply()メソッドの呼び出しを忘れないでください。

  • メソッドの詳細

    • getConditionTypes

      public Map<Integer,Map<String,XlFormatConditionType>> getConditionTypes()
      全条件付き書式の条件タイプ(どの種類を用いた条件付き書式なのか)を取得します。
      1. osbxlでは、priorityは、シート単位で一意に設定します(1から始まります。)。
      戻り値:
      Map＜プライオリティ(適用順序、値が低いほど先に適用する), Map＜セル範囲,条件付き書式の条件タイプ＞＞

    • getAppliedFontObject

      public Map<String,FontObjectWrapper> getAppliedFontObject(String A1C1)
      セル範囲の設定された条件付き書式のフォント書式を取得します。
      1. 条件付き書式が適用されているセルのみを返却します。
      パラメータ:
      A1C1 - セル範囲(A1C1)
      戻り値:
      Map＜適用されているセル範囲(A1),フォントオブジェクト＞

    • getAppliedFillObject

      public Map<String,FillObjectWrapper> getAppliedFillObject(String A1C1)
      セル範囲の設定された条件付き書式の塗りつぶし書式を取得します。
      1. 条件付き書式が適用されているセルのみを返却します。
      パラメータ:
      A1C1 - セル範囲(A1C1)
      戻り値:
      Map＜適用されているセル範囲(A1),塗りつぶしオブジェクト＞

    • getAppliedBordersObject

      public Map<String,BordersObjectWrapper> getAppliedBordersObject(String A1C1)
      セル範囲の設定された条件付き書式の枠線の書式(一括)を取得します。
      1. 条件付き書式が適用されているセルのみを返却します。
      パラメータ:
      A1C1 - セル範囲(A1C1)
      戻り値:
      Map＜適用されているセル範囲(A1),枠線の書式(一括)オブジェクト＞

    • getAppliedNumberFormat

      public Map<String,String> getAppliedNumberFormat(String A1C1)
      セル範囲の設定された条件付き書式のセル表示書式を取得します。
      1. 条件付き書式が適用されているセルのみを返却します。
      パラメータ:
      A1C1 - セル範囲(A1C1)
      戻り値:
      Map＜適用されているセル範囲(A1),セル表示書式＞

    • getAppliedDataBar

      public Map<String,Boolean> getAppliedDataBar(String A1C1)
      セル範囲の設定された条件付き書式のデータバーが含まれているかどうかを取得します。
      1. 条件付き書式が適用されているセルのみを返却します。
      パラメータ:
      A1C1 - セル範囲(A1C1)
      戻り値:
      Map＜適用されているセル範囲(A1),データバーが含まれているかどうか(true:含まれている)＞

    • getAppliedIconSetObject

      public Map<String,FilterIconsetObjectWrapper> getAppliedIconSetObject(String A1C1)
      セル範囲の設定された条件付き書式のアイコンセットの書式を取得します。
      1. 条件付き書式が適用されているセルのみを返却します。
      パラメータ:
      A1C1 - セル範囲(A1C1)
      戻り値:
      Map＜適用されているセル範囲(A1),アイコンセットオブジェクト＞

    • getCellValueCondition

      public CellValueObjectWrapper getCellValueCondition(int priority)
      CellValueCondition(セル値による条件付き書式)を取得します。
      1. `priority`は、条件のn番目を意味します。条件の先頭=1です。`priority`と条件タイプがあっていない場合、Exceptionとなります。
      2. getConditionTypesメソッドで、条件タイプ取得が可能です。
      パラメータ:
      priority - プライオリティ(適用順序、値が低いほど先に適用する)
      戻り値:
      条件付き書式セル値オブジェクト

    • getCellValueRangeCondition

      public CellValueRangeObjectWrapper getCellValueRangeCondition(int priority)
      CellValueRangeCondition(セル値範囲による条件付き書式)を取得します。
      1. `priority`は、条件のn番目を意味します。条件の先頭=1です。`priority`と条件タイプがあっていない場合、Exceptionとなります。
      2. getConditionTypesメソッドで、条件タイプ取得が可能です。
      パラメータ:
      priority - プライオリティ(適用順序、値が低いほど先に適用する)
      戻り値:
      条件付き書式セル値範囲オブジェクト

    • getAboveAverageCondition

      public AboveAverageObjectWrapper getAboveAverageCondition(int priority)
      AboveAverageCondition(平均値より上位/下位による条件付き書式)を取得します。
      1. `priority`は、条件のn番目を意味します。条件の先頭=1です。`priority`と条件タイプがあっていない場合、Exceptionとなります。
      2. getConditionTypesメソッドで、条件タイプ取得が可能です。
      パラメータ:
      priority - プライオリティ(適用順序、値が低いほど先に適用する)
      戻り値:
      条件付き書式平均値上位オブジェクト

    • getColorScaleFormatCondition

      public ColorScaleObjectWrapper getColorScaleFormatCondition(int priority)
      ColorScaleCondition(グラデーション色による条件付き書式)を取得します。
      1. `priority`は、条件のn番目を意味します。条件の先頭=1です。`priority`と条件タイプがあっていない場合、Exceptionとなります。
      2. getConditionTypesメソッドで、条件タイプ取得が可能です。
      パラメータ:
      priority - プライオリティ(適用順序、値が低いほど先に適用する)
      戻り値:
      条件付き書式グラデーション色オブジェクト

    • getTop10FormatCondition

      public Top10ObjectWrapper getTop10FormatCondition(int priority)
      Top10Condition(上位/下位N件(またはパーセント)による条件付き書式)を取得します。
      1. `priority`は、条件のn番目を意味します。条件の先頭=1です。`priority`と条件タイプがあっていない場合、Exceptionとなります。
      2. getConditionTypesメソッドで、条件タイプ取得が可能です。
      パラメータ:
      priority - int プライオリティ(適用順序、値が低いほど先に適用する)
      戻り値:
      条件付き書式上位下位オブジェクト

    • getIconsetFormatCondition

      public IconsetConditionObjectWrapper getIconsetFormatCondition(int priority)
      IconsetCondition(アイコンセットによる条件付き書式)を取得します。
      1. `priority`は、条件のn番目を意味します。条件の先頭=1です。`priority`と条件タイプがあっていない場合、Exceptionとなります。
      2. getConditionTypesメソッドで、条件タイプ取得が可能です。
      パラメータ:
      priority - プライオリティ(適用順序、値が低いほど先に適用する)
      戻り値:
      条件付き書式アイコンセットオブジェクト

    • getUniqueValuesFormatCondition

      public UniqueValuesObjectWrapper getUniqueValuesFormatCondition(int priority)
      UniqueValueCondition(ユニーク値による条件付き書式)を取得します。
      1. `priority`は、条件のn番目を意味します。条件の先頭=1です。`priority`と条件タイプがあっていない場合、Exceptionとなります。
      2. getConditionTypesメソッドで、条件タイプ取得が可能です。
      パラメータ:
      priority - プライオリティ(適用順序、値が低いほど先に適用する)
      戻り値:
      条件付き書式ユニーク値オブジェクト

    • getDataBarFormatCondition

      public DataBarObjectWrapper getDataBarFormatCondition(int priority)
      DataBarCondition(データバーによる条件付き書式)を取得します。
      1. `priority`は、条件のn番目を意味します。条件の先頭=1です。`priority`と条件タイプがあっていない場合、Exceptionとなります。
      2. getConditionTypesメソッドで、条件タイプ取得が可能です。
      パラメータ:
      priority - プライオリティ(適用順序、値が低いほど先に適用する)
      戻り値:
      条件付き書式データバーオブジェクト

    • apply

      public void apply()
      条件付き書式の適用を行います。
      1. 設定したFormatConditionsの適用を行います。
      2. このメソッドは全条件設定後に、必ず、呼び出す必要があります。

    • removeCondition

      public void removeCondition(int priority)
      条件付き書式の条件の個別削除を行います。
      パラメータ:
      priority - プライオリティ(適用順序、値が低いほど先に適用する)

    • removeAllCondition

      public void removeAllCondition()
      条件付き書式の条件の全削除を行います。

    • setCellValueCondition

      public void setCellValueCondition(int priority, CellValueObjectWrapper condition)
      CellValueCondition(セル値による条件付き書式)を設定します。
      1. `prirority`が既に存在する場合、存在する`priority`を後ろにずらします。
      パラメータ:
      priority - プライオリティ(適用順序、値が低いほど先に適用する)
      condition - 条件付き書式セル値オブジェクト

    • setCellValueRangeCondition

      public void setCellValueRangeCondition(int priority, CellValueRangeObjectWrapper condition)
      CellValueRangeCondition(セル値範囲による条件付き書式)を設定します。
      1. `prirority`が既に存在する場合、存在する`priority`を後ろにずらします。
      パラメータ:
      priority - プライオリティ(適用順序、値が低いほど先に適用する)
      condition - 条件付き書式セル値範囲オブジェクト

    • setAboveAverageCondition

      public void setAboveAverageCondition(int priority, AboveAverageObjectWrapper condition)
      AboveAverageCondition(平均値より上位による条件付き書式)を設定します。
      1. `prirority`が既に存在する場合、存在する`priority`を後ろにずらします。
      パラメータ:
      priority - プライオリティ(適用順序、値が低いほど先に適用する)
      condition - 条件付き書式平均値上位オブジェクト

    • setColorScaleFormatCondition

      public void setColorScaleFormatCondition(int priority, ColorScaleObjectWrapper condition)
      ColorScaleCondition(グラデーション色による条件付き書式)を設定します。
      1. `prirority`が既に存在する場合、存在する`priority`を後ろにずらします。
      パラメータ:
      priority - プライオリティ(適用順序、値が低いほど先に適用する)
      condition - 条件付き書式グラデーション色オブジェクト

    • setTop10FormatCondition

      public void setTop10FormatCondition(int priority, Top10ObjectWrapper condition)
      Top10Condition(上位/下位N件(またはパーセント)による条件付き書式)を設定します。
      1. `prirority`が既に存在する場合、存在する`priority`を後ろにずらします。
      パラメータ:
      priority - プライオリティ(適用順序、値が低いほど先に適用する)
      condition - 条件付き書式上位下位オブジェクト

    • setIconsetFormatCondition

      public void setIconsetFormatCondition(int priority, IconsetConditionObjectWrapper condition)
      IconsetCondition(アイコンセットによる条件付き書式)を設定します。
      1. `prirority`が既に存在する場合、存在する`priority`を後ろにずらします。
      パラメータ:
      priority - プライオリティ(適用順序、値が低いほど先に適用する)
      condition - 条件付き書式アイコンセットオブジェクト

    • setUniqueValuesFormatCondition

      public void setUniqueValuesFormatCondition(int priority, UniqueValuesObjectWrapper condition)
      UniqueValueCondition(ユニーク値による条件付き書式)を設定します。
      1. `prirority`が既に存在する場合、存在する`priority`を後ろにずらします。
      パラメータ:
      priority - プライオリティ(適用順序、値が低いほど先に適用する)
      condition - 条件付き書式ユニーク値オブジェクト

    • setDataBarFormatCondition

      public void setDataBarFormatCondition(int priority, DataBarObjectWrapper condition)
      DataBarCondition(データバーによる条件付き書式)を設定します。
      1. `prirority`が既に存在する場合、存在する`priority`を後ろにずらします。
      パラメータ:
      priority - プライオリティ(適用順序、値が低いほど先に適用する)
      condition - 条件付き書式データバーオブジェクト