モジュール jdk.xml.dom

パッケージ 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」も参照してください。

導入されたバージョン:

1.4、DOMレベル2

メソッドのサマリー

修飾子と型	メソッド	説明
String	getCssText()	宣言ブロックの、解析可能なテキスト表現(宣言を囲んでいる中括弧は除く)です。
int	getLength()	この宣言ブロック内で明示的に設定されているプロパティの数です。
CSSRule	getParentRule()	この宣言ブロックを含んでいるCSSルールです。または、このCSSStyleDeclarationがCSSRuleに結びつけられていない場合はnullです。
CSSValue	getPropertyCSSValue(String propertyName)	この宣言ブロック内で明示的に設定されているCSSプロパティの値のオブジェクト表現を取得するために使用します。
String	getPropertyPriority(String propertyName)	この宣言ブロック内でCSSプロパティの優先順位("important"識別子など)が明示的に設定されている場合に、その優先順位を取得するために使用します。
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です。