Liking cljdoc? Tell your friends :D

javax.swing.text.Element

Interface to describe a structural piece of a document. It is intended to capture the spirit of an SGML element.

Interface to describe a structural piece of a document.  It
is intended to capture the spirit of an SGML element.
raw docstring

get-attributesclj

(get-attributes this)

Fetches the collection of attributes this element contains.

returns: the attributes for the element - javax.swing.text.AttributeSet

Fetches the collection of attributes this element contains.

returns: the attributes for the element - `javax.swing.text.AttributeSet`
raw docstring

get-documentclj

(get-document this)

Fetches the document associated with this element.

returns: the document - javax.swing.text.Document

Fetches the document associated with this element.

returns: the document - `javax.swing.text.Document`
raw docstring

get-elementclj

(get-element this index)

Fetches the child element at the given index.

index - the specified index >= 0 - int

returns: the child element - javax.swing.text.Element

Fetches the child element at the given index.

index - the specified index >= 0 - `int`

returns: the child element - `javax.swing.text.Element`
raw docstring

get-element-countclj

(get-element-count this)

Gets the number of child elements contained by this element. If this element is a leaf, a count of zero is returned.

returns: the number of child elements >= 0 - int

Gets the number of child elements contained by this element.
 If this element is a leaf, a count of zero is returned.

returns: the number of child elements >= 0 - `int`
raw docstring

get-element-indexclj

(get-element-index this offset)

Gets the child element index closest to the given offset. The offset is specified relative to the beginning of the document. Returns -1 if the Element is a leaf, otherwise returns the index of the Element that best represents the given location. Returns 0 if the location is less than the start offset. Returns getElementCount() - 1 if the location is greater than or equal to the end offset.

offset - the specified offset >= 0 - int

returns: the element index >= 0 - int

Gets the child element index closest to the given offset.
 The offset is specified relative to the beginning of the
 document.  Returns -1 if the
 Element is a leaf, otherwise returns
 the index of the Element that best represents
 the given location.  Returns 0 if the location
 is less than the start offset. Returns
 getElementCount() - 1 if the location is
 greater than or equal to the end offset.

offset - the specified offset >= 0 - `int`

returns: the element index >= 0 - `int`
raw docstring

get-end-offsetclj

(get-end-offset this)

Fetches the offset from the beginning of the document that this element ends at. If this element has children, this will be the end offset of the last child. As a document position, there is an implied backward bias.

All the default Document implementations descend from AbstractDocument. AbstractDocument models an implied break at the end of the document. As a result of this, it is possible for this to return a value greater than the length of the document.

returns: the ending offset > getStartOffset() and <= getDocument().getLength() 1 - int

Fetches the offset from the beginning of the document
 that this element ends at.  If this element has
 children, this will be the end offset of the last child.
 As a document position, there is an implied backward bias.

 All the default Document implementations
 descend from AbstractDocument.
 AbstractDocument models an implied break at the end of
 the document. As a result of this, it is possible for this to
 return a value greater than the length of the document.

returns: the ending offset > getStartOffset() and
     <= getDocument().getLength()  1 - `int`
raw docstring

get-nameclj

(get-name this)

Fetches the name of the element. If the element is used to represent some type of structure, this would be the type name.

returns: the element name - java.lang.String

Fetches the name of the element.  If the element is used to
 represent some type of structure, this would be the type
 name.

returns: the element name - `java.lang.String`
raw docstring

get-parent-elementclj

(get-parent-element this)

Fetches the parent element. If the element is a root level element returns null.

returns: the parent element - javax.swing.text.Element

Fetches the parent element.  If the element is a root level
 element returns null.

returns: the parent element - `javax.swing.text.Element`
raw docstring

get-start-offsetclj

(get-start-offset this)

Fetches the offset from the beginning of the document that this element begins at. If this element has children, this will be the offset of the first child. As a document position, there is an implied forward bias.

returns: the starting offset >= 0 and < getEndOffset(); - int

Fetches the offset from the beginning of the document
 that this element begins at.  If this element has
 children, this will be the offset of the first child.
 As a document position, there is an implied forward bias.

returns: the starting offset >= 0 and < getEndOffset(); - `int`
raw docstring

leaf?clj

(leaf? this)

Is this element a leaf element? An element that may have children, even if it currently has no children, would return false.

returns: true if a leaf element else false - boolean

Is this element a leaf element? An element that
 may have children, even if it currently
 has no children, would return false.

returns: true if a leaf element else false - `boolean`
raw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close