モジュール java.desktop
パッケージ javax.print.attribute.standard

クラスMediaSize

  • すべての実装されたインタフェース:
    Serializable, Cloneable, Attribute
    public class MediaSize
extends Size2DSyntax
implements Attribute
    クラスMediaSizeは、縦方向の媒体のディメンションを示す2次元サイズ値の印刷属性クラスで、Xディメンションは下端に沿って実行され、Yディメンションは左端に沿って実行されます。 したがって、Yディメンションは、Xディメンション以上である必要があります。 クラスMediaSizeは、ISO、JIS、北米、エンジニアリングおよびその他のメディアのネストされたクラスに編成された、多数の標準メディア・サイズ値を宣言します。

    MediaSizeは、メディアを指定するためにまだ使用されていません。 現在の役割は指定された媒体へのマッピングです(MediaSizeNameを参照)。 クライアントは、マッピング・メソッドMediaSize.getMediaSizeForName(MediaSizeName)を使用して、このAPIに列挙されたMediaSizeNameインスタンスの物理ディメンションを検索できます。 このメソッドはこの情報を印刷の書式設定とページ作成に使用するクライアントで有効です。

    関連項目:
    直列化された形式

    • ネストされたクラスのサマリー

      ネストされたクラス 
      修飾子と型 クラス 説明
      static class  MediaSize.Engineering
      クラスMediaSize.Engineeringには、エンジニアリング・メディアのMediaSize値が含まれます。
      static class  MediaSize.ISO
      クラスMediaSize.ISOには、ISOメディアのMediaSize値が含まれます。
      static class  MediaSize.JIS
      クラスMediaSize.JISには、JIS (日本語)メディアのMediaSize値が含まれます。
      static class  MediaSize.NA
      クラスMediaSize.NAには、北米メディアのMediaSize値が含まれます。
      static class  MediaSize.Other
      クラスMediaSize.Otherには、その他のメディアのMediaSize値が含まれます。

    • フィールドのサマリー

    • コンストラクタのサマリー

      コンストラクタ 
      コンストラクタ 説明
      MediaSize​(float x, float y, int units)
      指定された浮動小数点値を使用して新しい媒体サイズ属性を構築します。
      MediaSize​(float x, float y, int units, MediaSizeName media)
      指定された浮動小数点値を使用して新しい媒体サイズ属性を構築します。
      MediaSize​(int x, int y, int units)
      指定された整数値を使用して新しい媒体サイズ属性を構築します。
      MediaSize​(int x, int y, int units, MediaSizeName media)
      指定された整数値を使用して新しい媒体サイズ属性を構築します。

    • コンストラクタの詳細

      • MediaSize

        public MediaSize​(float x,
                 float y,
                 int units)
        指定された浮動小数点値を使用して新しい媒体サイズ属性を構築します。
        パラメータ:
        x - Xディメンション
        y - Yディメンション
        units - 単位変換係数(例: Size2DSyntax.INCHまたはSize2DSyntax.MM)
        例外:
        IllegalArgumentException - x < 0、y < 0、units < 1またはx > yの場合

      • MediaSize

        public MediaSize​(int x,
                 int y,
                 int units)
        指定された整数値を使用して新しい媒体サイズ属性を構築します。
        パラメータ:
        x - Xディメンション
        y - Yディメンション
        units - 単位変換係数(例: Size2DSyntax.INCHまたはSize2DSyntax.MM)
        例外:
        IllegalArgumentException - x < 0、y < 0、units < 1またはx > yの場合

      • MediaSize

        public MediaSize​(float x,
                 float y,
                 int units,
                 MediaSizeName media)
        指定された浮動小数点値を使用して新しい媒体サイズ属性を構築します。
        パラメータ:
        x - Xディメンション
        y - Yディメンション
        units - 単位変換係数(例: Size2DSyntax.INCHまたはSize2DSyntax.MM)
        media - このMediaSizeに関連付けるメディア名
        例外:
        IllegalArgumentException - x < 0、y < 0、units < 1またはx > yの場合

      • MediaSize

        public MediaSize​(int x,
                 int y,
                 int units,
                 MediaSizeName media)
        指定された整数値を使用して新しい媒体サイズ属性を構築します。
        パラメータ:
        x - Xディメンション
        y - Yディメンション
        units - 単位変換係数(例: Size2DSyntax.INCHまたはSize2DSyntax.MM)
        media - このMediaSizeに関連付けるメディア名
        例外:
        IllegalArgumentException - x < 0、y < 0、units < 1またはx > yの場合

    • メソッドの詳細

      • getMediaSizeName

        public MediaSizeName getMediaSizeName()
        このサイズに対応する媒体が存在する場合、その名称を返します。
        戻り値:
        このメディア・サイズの名前。このサイズに名前が関連付けられていない場合はnull (匿名サイズ)

      • getMediaSizeForName

        public static MediaSize getMediaSizeForName​(MediaSizeName media)
        指定した名前付きメディアのMediaSizeを取得します。
        パラメータ:
        media - サイズが検索されるメディアの名前
        戻り値:
        メディアのサイズ。このメディアがどのサイズにも関連付けられていない場合はnull

      • findMedia

        public static MediaSizeName findMedia​(float x,
                                      float y,
                                      int units)
        指定されたディメンションは、すべての標準MediaSizeインスタンスの中から一致するMediaSizeインスタンスを見つけるために使用されます。 一致するものがない場合は一番近いものが使用されます。

        MediaSizeは、MediaSizeNameオブジェクトの検索に使用されます。 最も近いMediaSizeに対応するMediaインスタンスがない場合、このメソッドはnullを返します。

        このメソッドは、ディメンションのみを持ち、ディメンションに対応するMediaを検出するクライアントに役立ちます。

        パラメータ:
        x - Xディメンション
        y - Yディメンション
        units - 単位変換係数(例: Size2DSyntax.INCHまたはSize2DSyntax.MM)
        戻り値:
        これらのディメンションに一致するMediaSizeName、またはnull
        例外:
        IllegalArgumentException - x <= 0、y <= 0、またはunits < 1の場合

      • equals

        public boolean equals​(Object object)
        この媒体サイズ属性がオブジェクトで渡されるものと一致するかどうかを返します。 次の条件がすべてtrueの場合に同等とみなされます。
        1. objectはnullではありません。
        2. objectは、クラスMediaSizeのインスタンスです。
        3. このメディア・サイズ属性のXディメンションは、objectのXディメンションと同じです。
        4. このメディア・サイズ属性のYディメンションは、objectのYディメンションと同じです。
        オーバーライド:
        equals、クラスSize2DSyntax
        パラメータ:
        object - 比較するObject
        戻り値:
        objectがこのメディア・サイズ属性と同等の場合はtrue、そうでない場合はfalse
        関連項目:
        Object.hashCode()、HashMap

      • getCategory

        public final Class<? extends Attribute> getCategory()
        この印刷属性値の「カテゴリ」として使用される印刷属性クラスを返します。

        クラスMediaSizeおよびベンダー定義のサブクラスの場合、カテゴリはクラスMediaSize自体になります。

        定義:
        getCategory、インタフェースAttribute
        戻り値:
        属性クラス(カテゴリ)の出力、クラスjava.lang.Classのインスタンス

      • getName

        public final String getName()
        属性値がインスタンスとなるカテゴリの名前を返します。

        クラスMediaSizeおよびベンダー定義のサブクラスの場合、カテゴリ名は"media-size"です。

        定義:
        getName、インタフェースAttribute
        戻り値:
        属性カテゴリ名