共通 DOM API

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

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

setCssText

void setCssText(String cssText)
                throws DOMException
例外:
DOMException

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
この宣言ブロック内にプロパティ値と優先順位を設定するために使用します。

パラメータ:
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 ルールです。または、この CSSStyleDeclarationCSSRule に結び付けられていない場合は null です。


共通 DOM API

バグや機能要求の報告
Java は、米国およびその他の国における米国 Sun Microsystems, Inc. の商標もしくは登録商標です。
Copyright 2004 Sun Microsystems, Inc. 4150 Network Circle
Santa Clara, California, 95054, U.S.A. All Rights Reserved.