org.w3c.dom.css
インタフェース CSSPrimitiveValue

すべてのスーパーインタフェース:

CSSValue

public interface CSSPrimitiveValue
extends CSSValue

CSSPrimitiveValue インタフェースは、単一の CSS 値を表します。このインタフェースは、ブロック内で現在設定されている特定のスタイルプロパティの値を判別したり、ブロック内に特定のスタイルプロパティを明示的に指定したりするために使用できます。このインタフェースのインスタンスは、CSSStyleDeclaration インタフェースの getPropertyCSSValue メソッドから取得できます。CSSPrimitiveValue オブジェクトは、CSS プロパティのコンテキストにのみ出現します。

絶対値間での変換 (mm から cm へ、度からラジアンへ、など) は可能ですが、相対値間での変換 (ピクセル値から cm へ、など) はできません。また、パーセント値は、親値 (または別のプロパティ値) に対する相対的な値なので、変換できません。ただし、色のパーセント値は例外です。色のパーセント値は 0 〜 255 の範囲に対する相対値なので、色のパーセント値は数値に変換できます (RGBColor インタフェースも参照)。

「Document Object Model (DOM) Level 2 Style Specification」も参照してください。

導入されたバージョン:

DOM Level 2

フィールドの概要

static short	CSS_ATTR 値は属性関数です。
static short	CSS_CM 値は長さ (cm) です。
static short	CSS_COUNTER 値は、カウンタまたはカウンタ関数です。
static short	CSS_DEG 値は角度 (deg) です。
static short	CSS_DIMENSION 値は、寸法が不明な数値です。
static short	CSS_EMS 値は長さ (ems) です。
static short	CSS_EXS 値は長さ (exs) です。
static short	CSS_GRAD 値は角度 (grad) です。
static short	CSS_HZ 値は周波数 (Hz) です。
static short	CSS_IDENT 値は識別子です。
static short	CSS_IN 値は長さ (in) です。
static short	CSS_KHZ 値は周波数 (kHz) です。
static short	CSS_MM 値は長さ (mm) です。
static short	CSS_MS 値は時間 (ms) です。
static short	CSS_NUMBER 値は単純な数値です。
static short	CSS_PC 値は長さ (pc) です。
static short	CSS_PERCENTAGE 値はパーセントです。
static short	CSS_PT 値は長さ (pt) です。
static short	CSS_PX 値は長さ (px) です。
static short	CSS_RAD 値は角度 (rad) です。
static short	CSS_RECT 値は Rect 関数です。
static short	CSS_RGBCOLOR 値は RGB カラーです。
static short	CSS_S 値は時間 (s) です。
static short	CSS_STRING 値は文字列です。
static short	CSS_UNKNOWN CSS2 の値として認識できない値です。
static short	CSS_URI 値は URI です。

インタフェース org.w3c.dom.css.CSSValue から継承されたフィールド

CSS_CUSTOM, CSS_INHERIT, CSS_PRIMITIVE_VALUE, CSS_VALUE_LIST

メソッドの概要

Counter	getCounterValue() このメソッドは、カウンタ値を取得するために使用します。
float	getFloatValue(short unitType) このメソッドは、指定した単位の浮動小数点値を取得するために使用します。
short	getPrimitiveType() 前述の定数によって定義される、値の種類です。
Rect	getRectValue() このメソッドは、Rect 値を取得するために使用します。
RGBColor	getRGBColorValue() このメソッドは、RGB カラーを取得するために使用します。
String	getStringValue() このメソッドは、文字列値を取得するために使用します。
void	setFloatValue(short unitType, float floatValue) 指定した単位で浮動小数点値を設定するメソッドです。
void	setStringValue(short stringType, String stringValue) 指定した単位で文字列値を設定するメソッドです。

インタフェース org.w3c.dom.css.CSSValue から継承されたメソッド

getCssText, getCssValueType, setCssText

フィールドの詳細

CSS_UNKNOWN

static final short CSS_UNKNOWN

CSS2 の値として認識できない値です。この値を取得するには、cssText 属性を使用するしか方法がありません。

関連項目:

定数フィールド値

CSS_NUMBER

static final short CSS_NUMBER

値は単純な数値です。この値は、getFloatValue メソッドを使用して取得できます。

関連項目:

定数フィールド値

CSS_PERCENTAGE

static final short CSS_PERCENTAGE

値はパーセントです。この値は、getFloatValue メソッドを使用して取得できます。

関連項目:

定数フィールド値

CSS_EMS

static final short CSS_EMS

値は長さ (ems) です。この値は、getFloatValue メソッドを使用して取得できます。

関連項目:

定数フィールド値

CSS_EXS

static final short CSS_EXS

値は長さ (exs) です。この値は、getFloatValue メソッドを使用して取得できます。

関連項目:

定数フィールド値

CSS_PX

static final short CSS_PX

値は長さ (px) です。この値は、getFloatValue メソッドを使用して取得できます。

関連項目:

定数フィールド値

CSS_CM

static final short CSS_CM

値は長さ (cm) です。この値は、getFloatValue メソッドを使用して取得できます。

関連項目:

定数フィールド値

CSS_MM

static final short CSS_MM

値は長さ (mm) です。この値は、getFloatValue メソッドを使用して取得できます。

関連項目:

定数フィールド値

CSS_IN

static final short CSS_IN

値は長さ (in) です。この値は、getFloatValue メソッドを使用して取得できます。

関連項目:

定数フィールド値

CSS_PT

static final short CSS_PT

値は長さ (pt) です。この値は、getFloatValue メソッドを使用して取得できます。

関連項目:

定数フィールド値

CSS_PC

static final short CSS_PC

値は長さ (pc) です。この値は、getFloatValue メソッドを使用して取得できます。

関連項目:

定数フィールド値

CSS_DEG

static final short CSS_DEG

値は角度 (deg) です。この値は、getFloatValue メソッドを使用して取得できます。

関連項目:

定数フィールド値

CSS_RAD

static final short CSS_RAD

値は角度 (rad) です。この値は、getFloatValue メソッドを使用して取得できます。

関連項目:

定数フィールド値

CSS_GRAD

static final short CSS_GRAD

値は角度 (grad) です。この値は、getFloatValue メソッドを使用して取得できます。

関連項目:

定数フィールド値

CSS_MS

static final short CSS_MS

値は時間 (ms) です。この値は、getFloatValue メソッドを使用して取得できます。

関連項目:

定数フィールド値

CSS_S

static final short CSS_S

値は時間 (s) です。この値は、getFloatValue メソッドを使用して取得できます。

関連項目:

定数フィールド値

CSS_HZ

static final short CSS_HZ

値は周波数 (Hz) です。この値は、getFloatValue メソッドを使用して取得できます。

関連項目:

定数フィールド値

CSS_KHZ

static final short CSS_KHZ

値は周波数 (kHz) です。この値は、getFloatValue メソッドを使用して取得できます。

関連項目:

定数フィールド値

CSS_DIMENSION

static final short CSS_DIMENSION

値は、寸法が不明な数値です。この値は、getFloatValue メソッドを使用して取得できます。

関連項目:

定数フィールド値

CSS_STRING

static final short CSS_STRING

値は文字列です。この値は、getStringValue メソッドを使用して取得できます。

関連項目:

定数フィールド値

CSS_URI

static final short CSS_URI

値は URI です。この値は、getStringValue メソッドを使用して取得できます。

関連項目:

定数フィールド値

CSS_IDENT

static final short CSS_IDENT

値は識別子です。この値は、getStringValue メソッドを使用して取得できます。

関連項目:

定数フィールド値

CSS_ATTR

static final short CSS_ATTR

値は属性関数です。この値は、getStringValue メソッドを使用して取得できます。

関連項目:

定数フィールド値

CSS_COUNTER

static final short CSS_COUNTER

値は、カウンタまたはカウンタ関数です。この値は、getCounterValue メソッドを使用して取得できます。

関連項目:

定数フィールド値

CSS_RECT

static final short CSS_RECT

値は Rect 関数です。この値は、getRectValue メソッドを使用して取得できます。

関連項目:

定数フィールド値

CSS_RGBCOLOR

static final short CSS_RGBCOLOR

値は RGB カラーです。この値は、getRGBColorValue メソッドを使用して取得できます。

関連項目:

定数フィールド値

メソッドの詳細

getPrimitiveType

short getPrimitiveType()

前述の定数によって定義される、値の種類です。

setFloatValue

void setFloatValue(short unitType,
                   float floatValue)
                   throws DOMException

指定した単位で浮動小数点値を設定するメソッドです。この値が結び付けられるプロパティに、指定した単位または浮動小数点値が受け入れられない場合、値は変更されずに DOMException が発生します。

パラメータ:

unitType - 前述の単位コード。指定できるのは、浮動小数点型の単位のみ (つまり、CSS_NUMBER、CSS_PERCENTAGE、CSS_EMS、CSS_EXS、CSS_PX、CSS_CM、CSS_MM、CSS_IN、CSS_PT、CSS_PC、CSS_DEG、CSS_RAD、CSS_GRAD、CSS_MS、CSS_S、CSS_HZ、CSS_KHZ、CSS_DIMENSION)

floatValue - 新しい浮動小数点値

例外:

DOMException - INVALID_ACCESS_ERR: 結び付けられたプロパティが、浮動小数点値または指定された単位をサポートしていない場合に発生する
NO_MODIFICATION_ALLOWED_ERR: このプロパティが読み取り専用の場合に発生する

getFloatValue

float getFloatValue(short unitType)
                    throws DOMException

このメソッドは、指定した単位の浮動小数点値を取得するために使用します。この CSS 値に浮動小数点値が含まれていない場合、または指定された単位に変換できない場合には、DOMException が発生します。

パラメータ:

unitType - 浮動小数点値を取得するための単位コード。指定できるのは、浮動小数点型の単位のみ (つまり、CSS_NUMBER、CSS_PERCENTAGE、CSS_EMS、CSS_EXS、CSS_PX、CSS_CM、CSS_MM、CSS_IN、CSS_PT、CSS_PC、CSS_DEG、CSS_RAD、CSS_GRAD、CSS_MS、CSS_S、CSS_HZ、CSS_KHZ、CSS_DIMENSION)

戻り値:

指定された単位での浮動小数点値

例外:

DOMException - INVALID_ACCESS_ERR:CSS 値に浮動小数点値が含まれていない場合、または浮動小数点値を指定された単位に変換できない場合に発生する

setStringValue

void setStringValue(short stringType,
                    String stringValue)
                    throws DOMException

指定した単位で文字列値を設定するメソッドです。この値が結び付けられるプロパティが、指定した単位または文字列値を受け入れることができない場合、値は変更されずに、DOMException が発生します。

パラメータ:

stringType - 前述の文字列コード。指定できる文字列コードは、文字列の種類のみ (つまり、CSS_STRING、CSS_URI、CSS_IDENT、および CSS_ATTR)

stringValue - 新しい文字列値

例外:

DOMException - INVALID_ACCESS_ERR: CSS 値に文字列値が含まれていない場合、または文字列値を指定された単位に変換できない場合に発生する
NO_MODIFICATION_ALLOWED_ERR: このプロパティが読み取り専用の場合に発生する

getStringValue

String getStringValue()
                      throws DOMException

このメソッドは、文字列値を取得するために使用します。CSS 値に文字列値が含まれていない場合には、DOMException が発生します。一部のプロパティ (font-family や voice-family など) では、空白で区切られた識別子のリストが文字列に変換されます。

戻り値:

現在の単位での文字列値。現在の primitiveType としては、文字列の種類だけが可能 (つまり、CSS_STRING、CSS_URI、CSS_IDENT、および CSS_ATTR)

例外:

DOMException - INVALID_ACCESS_ERR:CSS 値に文字列値が含まれていない場合に発生する

getCounterValue

Counter getCounterValue()
                        throws DOMException

このメソッドは、カウンタ値を取得するために使用します。この CSS 値にカウンタ値が含まれていない場合には、DOMException が発生します。対応するスタイルプロパティを変更するには、Counter インタフェースを使用します。

戻り値:

カウンタ値

例外:

DOMException - INVALID_ACCESS_ERR:CSS 値にカウンタ値が含まれていない (たとえば、CSS 値が CSS_COUNTER ではない) 場合に発生する

getRectValue

Rect getRectValue()
                  throws DOMException

このメソッドは、Rect 値を取得するために使用します。この CSS 値に Rect 値が含まれていない場合には、DOMException が発生します。対応するスタイルプロパティを変更するには、Rect インタフェースを使用します。

戻り値:

Rect 値

例外:

DOMException - INVALID_ACCESS_ERR:CSS 値に Rect 値が含まれていない (たとえば、CSS 値が CSS_RECT ではない) 場合に発生する

getRGBColorValue

RGBColor getRGBColorValue()
                          throws DOMException

このメソッドは、RGB カラーを取得するために使用します。この CSS 値に RGB カラー値が含まれていない場合には、DOMException が発生します。対応するスタイルプロパティを変更するには、RGBColor インタフェースを使用します。

戻り値:

RGB カラー値

例外:

DOMException - INVALID_ACCESS_ERR:結び付けられたプロパティが、RGB カラー値を返すことができない (たとえば、プロパティが CSS_RGBCOLOR ではない) 場合に発生する