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

クラスMediaSize

  • すべての実装されたインタフェース:
    Serializable, Cloneable, Attribute

    public class MediaSize
extends Size2DSyntax
implements Attribute
    MediaSizeは縦長に置いた場合の媒体の寸法を2次元のサイズ値として示す印刷属性クラスです。X次元が底辺の長さ、Y次元が左辺の長さを表します。 Y次元の値はX次元の値以上である必要があります。 多くの標準的な媒体のサイズ値が宣言され、ネストされた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がこの媒体サイズ属性と一致する場合は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
        戻り値:
        属性カテゴリの名前