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

クラスMediaSize

java.lang.Object
javax.print.attribute.Size2DSyntax
javax.print.attribute.standard.MediaSize
すべての実装されたインタフェース:
Serializable, Cloneable, Attribute
public class MediaSize
extends Size2DSyntax
implements Attribute
クラスMediaSizeは、下端に沿って実行されるXディメンションと左端に沿って実行されるYディメンションを持つ、縦向きの媒体のディメンションを示す2ディメンションのサイズの値を持つ印刷属性クラスです。 したがって、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値が含まれています。

  • フィールドのサマリー

    クラス javax.print.attribute.Size2DSyntaxで宣言されたフィールド

    INCH, MM

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

    コンストラクタ 
    コンストラクタ 説明
    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)
    指定された整数値を使用して新しい媒体サイズ属性を構築します。

  • メソッドのサマリー

    修飾子と型 メソッド 説明
    boolean equals​(Object object)
    この媒体サイズ属性がオブジェクトで渡されるものと一致するかどうかを返します。
    static MediaSizeName findMedia​(float x, float y, int units)
    指定されたディメンションは、すべての標準MediaSizeインスタンスの中から一致するMediaSizeインスタンスを見つけるために使用されます。
    Class<? extends Attribute> getCategory()
    この印刷属性値の「カテゴリ」として使用される印刷属性クラスを返します。
    static MediaSize getMediaSizeForName​(MediaSizeName media)
    指定された名前のメディアのMediaSizeを取得します。
    MediaSizeName getMediaSizeName()
    このサイズに対応する媒体が存在する場合、その名称を返します。
    String getName()
    属性値がインスタンスとなるカテゴリの名前を返します。

    クラス javax.print.attribute.Size2DSyntaxで宣言されたメソッド

    getSize, getX, getXMicrometers, getY, getYMicrometers, hashCode, toString, toString

    クラス java.lang.Objectで宣言されたメソッド

    clone、finalize、getClass、notify、notifyAll、wait、wait、wait

  • コンストラクタの詳細

    • 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 objectがこのメディア・サイズ属性に相当する場合、それ以外の場合はfalse
      関連項目:
      Object.hashCode()、HashMap

    • getCategory

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

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

      定義:
      getCategory、インタフェース: Attribute
      戻り値:
      印刷属性クラス(category)、クラスjava.lang.Classのインスタンス

    • getName

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

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

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