pure.fw.brownie
[ class tree: pure.fw.brownie ] [ index: pure.fw.brownie ] [ all elements ]

Class: Brownie_Element

Source Location: /package/pure/fw/brownie/BrownieElement.inc

Class Overview

PURE_Class
   |
   --Brownie_Node
      |
      --Brownie_Element

エレメントの基本クラスです。


Author(s):

Constants

Methods


Child classes:

Brownie_Element_Root
文書のルートを表すエレメントの実装です。
Brownie_Element_Anonymous
無名のインデントを表すエレメントの実装です。
Brownie_Element_Blank
ブランクを表すエレメントの実装です。
Brownie_Element_Division
任意ブロックを表すエレメントの実装です。
Brownie_Element_Heading
見出し(H1xA携6)を保持するエレメントの実装です。
Brownie_Element_Paragraph
段落(P)を保持するエレメントの実装です。
Brownie_Element_OrderedList
順序リスト(OL)の項目(LI)を保持するエレメントの実装です。
Brownie_Element_UnorderedList
順不同リスト(UL)の項目(LI)を保持するエレメントの実装です。
Brownie_Element_DefineList
定義リスト(DL)の項目(DT)と内容(DD)を保持するエレメントの実装です。
Brownie_Element_BlockQuot
引用段落(BLOCKQUOT)を保持するエレメントの実装です。
Brownie_Element_HorizontalRule
水平罫線(HR)を保持するエレメントの実装です。

Inherited Constants

Inherited Methods

Class: Brownie_Node

Brownie_Node::__construct()
標準のコンストラクタです。
Brownie_Node::getType()
エレメントのタイプを取得します。
Brownie_Node::setType()
エレメントのタイプを設定します。

Class Details

[line 22]
エレメントの基本クラスです。

エレメントはBrownie形式テキストのブロック要素に当たり、行種を元に生成されます。 Brownie形式テキストの全ての行はエレメントに分割されて管理されます。




Tags:

abstract:  


[ Top ]


Class Methods


method addContain [line 117]

void addContain( Brownie_Element $contain)

エレメントに保有するエレメントを追加します。



Tags:

access:  public


Parameters:

Brownie_Element   $contain   エレメントに保有させるエレメント

[ Top ]

method addText [line 162]

void addText( string $text)

エレメントにテキストを追加します。

追加されるテストはaddContainメソッドで追加されるエレメントと同列で扱われます。 内部的にはテキストはBrownie_Textオブジェクトに変換されて格納されます。




Tags:

access:  public


Parameters:

string   $text   格納したいテキストオブジェクト

[ Top ]

method canCompact [line 210]

bool canCompact( )

コンパクト整形可能か否かを判定して返します。

コンパクト整形可能な条件は以下のようになります。

(1) 要素をひとつも持っていないか、ひとつのテキスト要素しか持っていないこと (2) テキスト要素内に改行文字がないこと




Tags:

return:  コンパクト整形出来るか否か
access:  public


[ Top ]

method getContain [line 145]

Brownie_Node getContain( int $index)

エレメントか保有している指定のインデックスのエレメント、データを取得します。

インデックスが不正の場合にはnullが返されます。




Tags:

return:  エレメントか保有している指定のインデックスのエレメント、データ
access:  public


Parameters:

int   $index   インデックス

[ Top ]

method getContainCount [line 132]

int getContainCount( )

エレメントか保有しているエレメント、データの個数を取得します。



Tags:

return:  エレメントか保有しているエレメント、データの個数
access:  public


[ Top ]

method getDepth [line 97]

int getDepth( )

エレメントの深さレベルを取得します。



Tags:

return:  深さレベル
access:  public


[ Top ]

method getInnerText [line 189]

Brownie_Text getInnerText( )

エレメントに直接保持されているテキスト要素を全て取得し、Brownie_Textオブジェクトに格納して返します。

別のエレメントに間接的に保持されているテキスト要素までは再帰的に検索しないことに注意してください。 テキスト要素を全く保持していない場合でも、空の値を保持したBrownie_Textオブジェクトが返されます。




Tags:

return:  テキスト要素を格納したBrownie_Textオブジェクト
access:  public


[ Top ]

method getParent [line 87]

Brownie_Element getParent( )

親エレメントを取得します。



Tags:

return:  親エレメント
access:  public


[ Top ]

method setDepth [line 107]

void setDepth( int $depth)

エレメントの深さレベルを設定します。



Tags:

access:  protected


Parameters:

int   $depth   深さレベル

[ Top ]

constructor __construct [line 63]

Brownie_Element __construct( [Brownie_Element $parent = null])

標準のコンストラクタです。



Tags:

access:  public


Overridden in child classes as:

Brownie_Element_Root::__construct()
標準のコンストラクタです。
Brownie_Element_Anonymous::__construct()
標準のコンストラクタです。
Brownie_Element_Blank::__construct()
標準のコンストラクタです。
Brownie_Element_Division::__construct()
標準のコンストラクタです。
Brownie_Element_Heading::__construct()
標準のコンストラクタです。
Brownie_Element_Paragraph::__construct()
標準のコンストラクタです。
Brownie_Element_OrderedList::__construct()
標準のコンストラクタです。
Brownie_Element_UnorderedList::__construct()
標準のコンストラクタです。
Brownie_Element_DefineList::__construct()
標準のコンストラクタです。
Brownie_Element_BlockQuot::__construct()
標準のコンストラクタです。
Brownie_Element_HorizontalRule::__construct()
標準のコンストラクタです。

Overrides Brownie_Node::__construct() (標準のコンストラクタです。)

Parameters:

Brownie_Element   $parent   親エレメント

[ Top ]


Class Constants

TYPE_ANONYMOUS =  199

[line 35]


[ Top ]

TYPE_BLANK =  101

[line 25]


[ Top ]

TYPE_BLOCKQUOT =  109

[line 33]


[ Top ]

TYPE_DEFINE_LIST =  108

[line 32]


[ Top ]

TYPE_DIVISION =  102

[line 26]


[ Top ]

TYPE_HEADING =  104

[line 28]


[ Top ]

TYPE_HORIZONTAL_RULE =  110

[line 34]


[ Top ]

TYPE_ORDERED_LIST =  106

[line 30]


[ Top ]

TYPE_PARAGRAPH =  105

[line 29]


[ Top ]

TYPE_ROOT =  103

[line 27]


[ Top ]

TYPE_UNKNOWN =  -100

[line 24]


[ Top ]

TYPE_UNORDERED_LIST =  107

[line 31]


[ Top ]



Documentation generated on Sun, 06 Jan 2008 01:33:02 +0900 by phpDocumentor 1.3.2