nsIFeedTextConstruct
出典: MDC
nsIFeedTextConstruct インタフェースはプレーンテキストや HTML あるいは XHTML を含む RSS, Atom フィードのテキストフィールドを記述します。いくつかの拡張要素は "type" パラメータも含んでおり、このインタフェースはそれらも同様に記述します。
目次 |
nsIFeedTextConstruct は toolkit/components/feeds/public/nsIFeedTextConstruct.idl で定義されています。これは scriptable で
非凍結です。 (Mozilla 1.8.1から更新されていません)
継承元: nsISupports
実装元: @mozilla.org/feed-textconstruct;1。ユーザは通常、このインスタンスを直接作成する必要はありません。他の nsIFeed や nsIFeedEntry, nsIFeedContainer などのフィード関連のインタフェースは、nsIFeedTextConstruct を実装するオブジェクトを返す属性を持っています。
[編集] メソッドの概要
nsIDOMDocumentFragment createDocumentFragment(in nsIDOMElement element);
|
AString plainText();
|
[編集] 属性
| 属性 | 型 | 説明 |
base
| nsIURI
| テキスト構造物が HTML あるいは XHTML を含んでいた場合、コンテントの相対参照はこの base URI を使って解決されるべきです。 |
lang
| AString
| テキストの言語(アメリカ英語では "en-US")。 |
text
| AString
| 実際のテキストコンテント。type が "html" か "xhtml" のどちらかではこの文字列はマークアップを含みます。
|
type
| AString
| 記述されているコンテントの種類; "text" か "html" あるいは "xhtml" のどれか一つ。 |
[編集] メソッド
[編集] createDocumentFragment()
与えられた DOM 要素の上に新しい document fragment を作ります。それはテキストと(もしテキストが HTML あるいは XHTML を構成しているなら)マークアップを含みます。
nsIDOMDocumentFragment createDocumentFragment( in nsIDOMElement element );
[編集] パラメータ
- element
- 新しい document fragment を作る要素。
[編集] 戻り値
nsIDocumentFragment はテキストとマークアップを含みます。
[編集] plainText()
テキストを全てのマークアップを取り除き全てのエンティティをデコードしてプレーンテキストとして返します。
AString plainText();
[編集] 戻り値
テキスト構造物のコンテントのプレーンテキスト版。もし type 属性が "text" の場合、このメソッドは text 属性の変更されていない値を返します。
[編集] 備考
もし ドキュメントの type が "html" あるいは "xhtml" の場合、"<" 文字はマークアップを意味します。その文字を表示するためには、"<" のようなエスケープが使われなくてはなりません。type が "text" の場合、"<" 文字はそれ自身を表します。