パッケージ jp.co.antenna.ptl

クラス PtlParamFont

java.lang.Object
jp.co.antenna.ptl.PtlParamFont
すべての実装されたインタフェース:
AutoCloseable
public class PtlParamFont extends Object implements AutoCloseable
PtlContent/PtlPramWatermarkTextのフォント指定に使うパラメータクラスです。

  • ネストされたクラスの概要

    ネストされたクラス
    修飾子とタイプ
    クラス
    説明
    static enum 
    PtlParamFont.WEIGHT
    ウェイト

  • コンストラクタの概要

    コンストラクタ
    コンストラクタ
    説明
    PtlParamFont()
    コンストラクタ
    PtlParamFont(String name, float size, boolean bBold, boolean bItalic, boolean bEmbed)
    コンストラクタ
    PtlParamFont(String name, float size, PtlParamFont.WEIGHT weight, boolean bItalic, boolean bEmbed)
    コンストラクタ
    PtlParamFont(PtlParamFont obj)
    コピーコンストラクタ
    alias copy

  • メソッドの概要

    修飾子とタイプ
    メソッド
    説明
    void
    close()
    終了処理。
    float
    getStringWidth(String str)
    文字列幅を取得。
    void
    setBold(boolean bBold)
    ボールドか否かを設定。
    void
    setEmbed(boolean bEmbed)
    フォント埋め込みにするか否かを設定。
    void
    setFontSize(float size)
    フォントサイズを設定。
    void
    setItalic(boolean bItalic)
    イタリックか否かを設定。
    void
    setName(String name)
    フォント名を設定。
    void
    setSize(float size)
    フォントサイズを設定(ポイント)。
    void
    setWeight(PtlParamFont.WEIGHT weight)
    ウエイトを設定。

    クラスから継承されたメソッド java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • コンストラクタの詳細

    • PtlParamFont

      public PtlParamFont() throws PtlException
      コンストラクタ
      例外:
      PtlException - 例外

    • PtlParamFont

      public PtlParamFont(String name, float size, boolean bBold, boolean bItalic, boolean bEmbed) throws PtlException
      コンストラクタ
      パラメータ:
      name - フォント名
      size - フォントサイズ(ポイント)
      bBold - ボールド(trueならボールド)
      bItalic - イタリック(trueならイタリック)
      イタリックは縦書きには対応していません。
      bEmbed - フォント埋め込みか(trueなら埋め込む)
      例外:
      PtlException - 例外

    • PtlParamFont

      public PtlParamFont(String name, float size, PtlParamFont.WEIGHT weight, boolean bItalic, boolean bEmbed) throws PtlException
      コンストラクタ
      パラメータ:
      name - フォント名
      size - フォントサイズ(ポイント)
      weight - ウェイト(WEIGHT_XXXXの指定も可能)
      指定されたウェイトのものをフォントファイルから探しますが、
      なければ700以上のものはボールド、それ以外はノーマルとみなします。
      bItalic - イタリック(trueならイタリック)
      イタリックは縦書きには対応していません。
      bEmbed - フォント埋め込みか(trueなら埋め込む)
      例外:
      PtlException - 例外

    • PtlParamFont

      public PtlParamFont(PtlParamFont obj) throws PtlException
      コピーコンストラクタ
      alias copy
      パラメータ:
      obj - コピー元オブジェクト。
      例外:
      PtlException - 例外

  • メソッドの詳細

    • close

      public void close()
      終了処理。

      このオブジェクトが抱えているネイティブ側にあるリソースなどを廃棄して終了処理を行ないます。
      このオブジェクトを使い終わったら必ず呼ばなければなりません。

      定義:
      close インタフェース内 AutoCloseable

    • setName

      public void setName(String name) throws PtlException
      フォント名を設定。
      パラメータ:
      name - フォント名
      例外:
      PtlException - 例外

    • setSize

      public void setSize(float size) throws PtlException
      フォントサイズを設定(ポイント)。

      設定しない場合はデフォルト値として12ポイントが使用されます。
      フォントサイズをポイントからmmに換算は、フォントサイズ*25.4/72 で行います。

      パラメータ:
      size - フォントサイズ(ポイント)
      例外:
      PtlException - 例外

    • setFontSize

      public void setFontSize(float size) throws PtlException
      フォントサイズを設定。

      設定しない場合はデフォルト値として12ポイント(=12*25.4/72mm)が使用されます。

      パラメータ:
      size - フォントサイズ(mm)
      例外:
      PtlException - 例外

    • setBold

      public void setBold(boolean bBold) throws PtlException
      ボールドか否かを設定。

      設定しない場合はデフォルト値としてfalseが使用されます。

      パラメータ:
      bBold - trueならボールド
      例外:
      PtlException - 例外

    • setWeight

      public void setWeight(PtlParamFont.WEIGHT weight) throws PtlException
      ウエイトを設定。

      設定しない場合はデフォルト値として400が使用されます。

      パラメータ:
      weight - ウエイト(WEIGHT_XXXXの指定も可能)
      指定されたウェイトのものをフォントファイルから探しますが、
      なければ700以上のものはボールド、それ以外はノーマルとみなします。
      例外:
      PtlException - 例外

    • setItalic

      public void setItalic(boolean bItalic) throws PtlException
      イタリックか否かを設定。

      設定しない場合はデフォルト値としてfalseが使用されます。

      パラメータ:
      bItalic - trueならイタリック
      縦書きではイタリックの指定があってもフォントがイタリックのグリフを
      持っていない場合はイタリックとなりません。
      例外:
      PtlException - 例外

    • setEmbed

      public void setEmbed(boolean bEmbed) throws PtlException
      フォント埋め込みにするか否かを設定。

      設定しない場合はデフォルト値としてtrueが使用されます。

      パラメータ:
      bEmbed - trueならフォント埋め込み
      例外:
      PtlException - 例外

    • getStringWidth

      public float getStringWidth(String str) throws PtlException
      文字列幅を取得。

      単位はmmとなりますので注意してください。

      パラメータ:
      str - 文字列
      戻り値:
      文字列幅
      例外:
      PtlException - 例外