LeafElement (Editor Library) - NetBeans API Javadoc (Current Development Version)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

org.netbeans.modules.editor.lib/1 1.14.0 3

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.netbeans.editor
Class LeafElement

java.lang.Object
  org.netbeans.editor.BaseElement
      org.netbeans.editor.LeafElement

All Implemented Interfaces:: Element

public class LeafElement
extends BaseElement
extends BaseElement

Leaf element is used on the leaf level of element tree.

Field Summary

protected boolean bol
          Does this view begin at line begining

protected Mark endMark
          Mark giving end offset of this element

protected boolean eol
          Does this view end at line end

protected Mark startMark
          Mark giving start offset of this element

Fields inherited from class org.netbeans.editor.BaseElement

attrs, doc, ElementNameAttribute, parent

Constructor Summary

LeafElement(BaseDocument doc, BaseElement parent, AttributeSet attrs, int startOffset, int endOffset, boolean bol, boolean eol)
          Create new document instance

Method Summary

protected void finalize()


Element getElement(int index)
          Get child of this element at specified index or itself if the index is too big

int getElementCount()
          Get number of children of this element

int getElementIndex(int offset)
          Gets the child element index closest to the given offset.

Mark getEndMark()
          Get end mark of this element

int getEndOffset()
          Get end offset of this element

Mark getStartMark()
          Get start mark of this element

int getStartOffset()
          Get start offset of this element

boolean isBOL()
          Is this view begining at begin of line

boolean isEOL()
          Is this view ending at end of line ?

boolean isLeaf()
          Does this element have any children?

String toString()


Methods inherited from class org.netbeans.editor.BaseElement

getAttributes, getDocument, getName, getParentElement

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Summary
`protected boolean`	`bol` Does this view begin at line begining
`protected Mark`	`endMark` Mark giving end offset of this element
`protected boolean`	`eol` Does this view end at line end
`protected Mark`	`startMark` Mark giving start offset of this element

Fields inherited from class org.netbeans.editor.BaseElement
`attrs, doc, ElementNameAttribute, parent`

Constructor Summary
`LeafElement(BaseDocument doc, BaseElement parent, AttributeSet attrs, int startOffset, int endOffset, boolean bol, boolean eol)` Create new document instance

Method Summary
`protected void`	`finalize()`
`Element`	`getElement(int index)` Get child of this element at specified index or itself if the index is too big
`int`	`getElementCount()` Get number of children of this element
`int`	`getElementIndex(int offset)` Gets the child element index closest to the given offset.
`Mark`	`getEndMark()` Get end mark of this element
`int`	`getEndOffset()` Get end offset of this element
`Mark`	`getStartMark()` Get start mark of this element
`int`	`getStartOffset()` Get start offset of this element
`boolean`	`isBOL()` Is this view begining at begin of line
`boolean`	`isEOL()` Is this view ending at end of line ?
`boolean`	`isLeaf()` Does this element have any children?
`String`	`toString()`

Methods inherited from class org.netbeans.editor.BaseElement
`getAttributes, getDocument, getName, getParentElement`

Methods inherited from class java.lang.Object
`clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Field Detail

startMark

protected Mark startMark

Mark giving start offset of this element

endMark

protected Mark endMark

Mark giving end offset of this element

bol

protected boolean bol

Does this view begin at line begining

eol

protected boolean eol

Does this view end at line end

Constructor Detail

LeafElement

public LeafElement(BaseDocument doc,
                   BaseElement parent,
                   AttributeSet attrs,
                   int startOffset,
                   int endOffset,
                   boolean bol,
                   boolean eol)

Create new document instance

Method Detail

finalize

protected void finalize()
                 throws Throwable

Overrides:: finalize in class Object

Throws:: Throwable

getStartMark

public final Mark getStartMark()

Get start mark of this element

Specified by:: getStartMark in class BaseElement

getStartOffset

public final int getStartOffset()

Get start offset of this element

Specified by:: getStartOffset in interface Element
Specified by:: getStartOffset in class BaseElement

getEndMark

public final Mark getEndMark()

Get end mark of this element

Specified by:: getEndMark in class BaseElement

getEndOffset

public final int getEndOffset()

Get end offset of this element

Specified by:: getEndOffset in interface Element
Specified by:: getEndOffset in class BaseElement

isBOL

public final boolean isBOL()

Is this view begining at begin of line

isEOL

public final boolean isEOL()

Is this view ending at end of line ?

getElementIndex

public int getElementIndex(int offset)

Gets the child element index closest to the given offset. For leaf element this returns -1.

Specified by:: getElementIndex in interface Element
Specified by:: getElementIndex in class BaseElement

getElementCount

public int getElementCount()

Get number of children of this element

Specified by:: getElementCount in interface Element
Specified by:: getElementCount in class BaseElement

getElement

public Element getElement(int index)

Get child of this element at specified index or itself if the index is too big

Specified by:: getElement in interface Element
Specified by:: getElement in class BaseElement

isLeaf

public boolean isLeaf()

Does this element have any children?

Specified by:: isLeaf in interface Element
Specified by:: isLeaf in class BaseElement

toString

public String toString()

Overrides:: toString in class Object