org.w3c.dom.css

インタフェース CSSStyleDeclaration

public interface CSSStyleDeclaration

CSSStyleDeclaration インタフェースは、単一の CSS 宣言ブロックを表します。このインタフェースは、ブロック内で現在設定されているスタイルプロパティーを判別したり、ブロック内にスタイルプロパティーを明示的に指定したりするために使用できます。

実装によっては CSS 宣言ブロック内の一部の CSS プロパティーを認識できない場合があるため、スタイルシート内に指定されているすべてのプロパティーに CSSStyleDeclaration インタフェースによってアクセスできるようにすることが期待されています。さらに、特定のレベルの CSS をサポートしている実装は、そのレベルの CSS の短縮形プロパティーを正しく処理できる必要があります。短縮形のプロパティーについて詳しくは、CSS2Properties インタフェースを参照してください。

このインタフェースは、要素の計算された値への読み取り専用アクセスを提供するためにも使用されます。ViewCSS インタフェースも参照してください。CSS のオブジェクトモデルでは、CSS カスケードの指定した値、または実際の値にアクセスする手段は提供されていません。

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

導入されたバージョン:

DOM Level 2

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
String	getCssText() 宣言ブロックの、解析可能なテキスト表現 (宣言を囲んでいる中括弧は除く) です。
int	getLength() この宣言ブロック内で明示的に設定されているプロパティーの数です。
CSSRule	getParentRule() この宣言ブロックを含んでいる CSS ルールです。または、この CSSStyleDeclaration が CSSRule に結びつけられていない場合は null です。
CSSValue	getPropertyCSSValue(String propertyName) この宣言ブロック内で明示的に設定されている CSS プロパティーの値のオブジェクト表現を取得するために使用します。
String	getPropertyPriority(String propertyName) CSS プロパティーの優先順位を取得するために使用します。
String	getPropertyValue(String propertyName) この宣言ブロック内で明示的に設定されている CSS プロパティーの値を取得するために使用します。
String	item(int index) この宣言ブロック内で明示的に設定されているプロパティーを取得するために使用します。
String	removeProperty(String propertyName) この宣言ブロック内で明示的に設定されている CSS プロパティーを削除するために使用します。
void	setCssText(String cssText) 宣言ブロックの、解析可能なテキスト表現 (宣言を囲んでいる中括弧は除く) です。
void	setProperty(String propertyName, String value, String priority) この宣言ブロック内にプロパティー値と優先順位を設定するために使用します。

メソッドの詳細

getCssText

String getCssText()

宣言ブロックの、解析可能なテキスト表現 (宣言を囲んでいる中括弧は除く) です。この属性に値を設定すると、新しい値が解析されて、宣言ブロック内のすべてのプロパティーがリセットされます。これには、プロパティーの削除や追加も含まれます。

setCssText

void setCssText(String cssText)
                throws DOMException

宣言ブロックの、解析可能なテキスト表現 (宣言を囲んでいる中括弧は除く) です。この属性に値を設定すると、新しい値が解析されて、宣言ブロック内のすべてのプロパティーがリセットされます。これには、プロパティーの削除や追加も含まれます。

例外:

DOMException - SYNTAX_ERR:指定された CSS 文字列値に構文エラーがあり、解析できない場合に発生する。
NO_MODIFICATION_ALLOWED_ERR:この宣言が読み取り専用か、プロパティーが読み取り専用である場合に発生する

getPropertyValue

String getPropertyValue(String propertyName)

この宣言ブロック内で明示的に設定されている CSS プロパティーの値を取得するために使用します。

パラメータ:

propertyName - CSS プロパティーの名前。CSS プロパティーのインデックスを参照

戻り値:

プロパティーがこの宣言ブロック内で明示的に設定されている場合は、そのプロパティーの値を返す。そのプロパティーが設定されていない場合は、空の文字列を返す

getPropertyCSSValue

CSSValue getPropertyCSSValue(String propertyName)

この宣言ブロック内で明示的に設定されている CSS プロパティーの値のオブジェクト表現を取得するために使用します。プロパティーが短縮形プロパティーの場合、このメソッドは null を返します。短縮形プロパティーの値は、getPropertyValue および setProperty メソッドを使用して、文字列としてのみ取得したり修正したりできます。

パラメータ:

propertyName - CSS プロパティーの名前。CSS プロパティーのインデックスを参照

戻り値:

プロパティーがこの宣言ブロック内で明示的に設定されている場合は、そのプロパティーの値を返す。そのプロパティーが設定されていない場合は、null を返す。

removeProperty

String removeProperty(String propertyName)
                      throws DOMException

この宣言ブロック内で明示的に設定されている CSS プロパティーを削除するために使用します。

パラメータ:

propertyName - CSS プロパティーの名前。CSS プロパティーのインデックスを参照

戻り値:

プロパティーがこの宣言ブロック内で明示的に設定されている場合は、そのプロパティーの値を返す。そのプロパティーが設定されていない場合、またはプロパティー名が既知の CSS プロパティーに対応していない場合には、空の文字列を返す。

例外:

DOMException - NO_MODIFICATION_ALLOWED_ERR: この宣言が読み取り専用であるか、プロパティーが読み取り専用である場合に発生する。

getPropertyPriority

String getPropertyPriority(String propertyName)

この宣言ブロック内で CSS プロパティーの優先順位 ("important" 識別子など) が明示的に設定されている場合に、その優先順位を取得するために使用します。

パラメータ:

propertyName - CSS プロパティーの名前。CSS プロパティーのインデックスを参照

戻り値:

プロパティーがこの宣言ブロック内に明示的に設定され、優先順位が指定されている場合は、その優先順位を表す文字列 ("important" など)。そうでない場合は空の文字列

setProperty

void setProperty(String propertyName,
               String value,
               String priority)
                 throws DOMException

この宣言ブロック内にプロパティー値と優先順位を設定するために使用します。setProperty で、宣言ブロック内のプロパティーを変更するか、新しいプロパティーを追加できます。このメソッドの呼び出しにより、item メソッドのプロパティーの順序が変更されることがあります。

パラメータ:

propertyName - CSS プロパティーの名前。CSS プロパティーのインデックスを参照

value - プロパティーの新しい値。

priority - プロパティーの新しい優先順位 ("important" など)。優先順位が存在しない場合は、空の文字列。

例外:

DOMException - SYNTAX_ERR:指定された値に構文エラーがあり、解析できない場合に発生する。
NO_MODIFICATION_ALLOWED_ERR:この宣言が読み取り専用であるか、プロパティーが読み取り専用である場合に発生する。

getLength

int getLength()

この宣言ブロック内で明示的に設定されているプロパティーの数です。有効なインデックスの範囲は、0 から length-1 までです。

item

String item(int index)

この宣言ブロック内で明示的に設定されているプロパティーを取得するために使用します。このメソッドを使用して取得するプロパティーの順序は、設定された順序と同じである必要はありません。このメソッドは、宣言ブロック内のすべてのプロパティーを反復して処理するために利用できます。

パラメータ:

index - 取得するプロパティー名のインデックス。

戻り値:

この順序位置にあるプロパティーの名前。この位置にプロパティーが存在しない場合は、空の文字列

getParentRule

CSSRule getParentRule()

この宣言ブロックを含んでいる CSS ルールです。または、この CSSStyleDeclaration が CSSRule に結びつけられていない場合は null です。