net.sgoliver.jrtftree.core
Class RtfTreeNode

java.lang.Object
  extended bynet.sgoliver.jrtftree.core.RtfTreeNode

public class RtfTreeNode
extends java.lang.Object

Nodo RTF de la representación en árbol de un documento.


Constructor Summary
RtfTreeNode()
          Constructor por defecto de la clase.
RtfTreeNode(int nodeType)
          Constructor de la clase.
RtfTreeNode(int nodeType, java.lang.String key, boolean hasParam, int param)
          Constructor de la clase.
 
Method Summary
 void appendChild(RtfTreeNode newNode)
          Añade un nodo al final de la lista de hijos.
 RtfTreeNode cloneNode(boolean cloneChildren)
          Realiza una copia exacta del nodo actual.
 RtfTreeNode firstChild()
          Obtiene el primer nodo hijo del nodo actual.
 RtfNodeCollection getChildNodes()
          Obtienen la colección de nodos hijo del nodo actual.
 boolean getHasParameter()
          Obtiene el indicativo de existencia de parámetro asociado al nodo.
 java.lang.String getNodeKey()
          Obtiene la clave del nodo actual.
 int getNodeType()
          Obtiene el tipo de nodo actual.
 int getParameter()
          Obtiene el parámetro asociado al nodo.
 RtfTreeNode getParentNode()
          Obtiene el nodo padre del nodo actual.
 RtfTreeNode getRootNode()
          Obtiene el nodo raíz del árbol RTF.
 java.lang.String getRtf()
          Devuelve el código RTF del nodo actual y todos sus nodos hijos.
 boolean hasChildNodes()
          Indica si el nodo actual tiene nodos hijos.
 RtfTreeNode lastChild()
          Obtiene el último nodo hijo del nodo actual.
 RtfTreeNode nextSibling()
          Obtiene el nodo hermano siguiente del nodo actual (Dos nodos son hermanos si tienen el mismo nodo padre [ParentNode]).
 RtfTreeNode previousSibling()
          Obtiene el nodo hermano anterior del nodo actual (Dos nodos son hermanos si tienen el mismo nodo padre [ParentNode]).
 void removeChild(int index)
          Elimina un nodo de la lista de hijos.
 void removeChild(RtfTreeNode node)
          Elimina un nodo de la lista de hijos.
 RtfNodeCollection selectChildNodes(java.lang.String keyword)
          Devuelve todos los nodos de la lista de nodos hijos del nodo actual cuya palabra clave es la indicada como parámetro.
 RtfNodeCollection selectChildNodesByType(int nodeType)
          Devuelve todos los nodos de la lista de nodos hijos del nodo actual cuyo tipo es el indicado como parámetro.
 RtfNodeCollection selectNodes(java.lang.String keyword)
          Devuelve todos los nodos, a partir del nodo actual, cuya palabra clave es la indicada como parámetro.
 RtfNodeCollection selectNodesByType(int nodeType)
          Devuelve todos los nodos, a partir del nodo actual, cuyo tipo es el indicado como parámetro.
 RtfTreeNode selectSingleChildNode(java.lang.String keyword)
          Devuelve el primer nodo de la lista de nodos hijos del nodo actual cuya palabra clave es la indicada como parámetro.
 RtfTreeNode selectSingleChildNodeByType(int nodeType)
          Devuelve el primer nodo de la lista de nodos hijos del nodo actual cuyo tipo es el indicado como parámetro.
 RtfTreeNode selectSingleNode(java.lang.String keyword)
          Devuelve el primer nodo del árbol, a partir del nodo actual, cuya palabra clave es la indicada como parámetro.
 RtfTreeNode selectSingleNodeByType(int nodeType)
          Devuelve el primer nodo del árbol, a partir del nodo actual, cuyo tipo es el indicado como parámetro.
 void setChildNodes(RtfNodeCollection children)
          Establece la colección de nodos hijo del nodo actual.
 void setHasParamenter(boolean hasParam)
          Establece el indicativo de existencia de parámetro asociado al nodo.
 void setNodeKey(java.lang.String key)
          Establece la clave del nodo actual.
 void setNodeType(int nodeType)
          Establece el tipo de nodo actual.
 void setParameter(int param)
          Establece el parámetro asociado al nodo.
 void setParentNode(RtfTreeNode node)
          Establece el nodo padre del nodo actual.
 void setRootNode(RtfTreeNode node)
          Establece el nodo raíz del árbol RTF.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RtfTreeNode

public RtfTreeNode()
Constructor por defecto de la clase.


RtfTreeNode

public RtfTreeNode(int nodeType)
Constructor de la clase. Crea un nodo vacío del tipo pasado como parámetro.

Parameters:
nodeType - Tipo de nodo a crear.

RtfTreeNode

public RtfTreeNode(int nodeType,
                   java.lang.String key,
                   boolean hasParam,
                   int param)
Constructor de la clase. Crea un nodo completo con los datos suministrados como parñametros.

Parameters:
nodeType - Tipo de nodo.
key - Clave del nodo.
hasParam - Indicativo de existencia de parámetro.
param - Parámetro del nodo, en caso de existir.
Method Detail

appendChild

public void appendChild(RtfTreeNode newNode)
Añade un nodo al final de la lista de hijos.

Parameters:
newNode - Nuevo nodo a añadir.

cloneNode

public RtfTreeNode cloneNode(boolean cloneChildren)
Realiza una copia exacta del nodo actual.

Parameters:
cloneChildren - Si este parámetro recibe el valor true se clonarán también todos los nodos hijo del nodo actual.
Returns:
Devuelve una copia exacta del nodo actual.

firstChild

public RtfTreeNode firstChild()
Obtiene el primer nodo hijo del nodo actual.

Returns:
Primer nodo hijo del nodo actual.

getChildNodes

public RtfNodeCollection getChildNodes()
Obtienen la colección de nodos hijo del nodo actual.

Returns:
Colección de nodos hijo del nodo actual.

getHasParameter

public boolean getHasParameter()
Obtiene el indicativo de existencia de parámetro asociado al nodo.

Returns:
Indicativo de existencia de parámetro asociado al nodo.

getNodeKey

public java.lang.String getNodeKey()
Obtiene la clave del nodo actual.

Returns:
Clave del nodo actual.

getNodeType

public int getNodeType()
Obtiene el tipo de nodo actual.

Returns:
Tipo del nodo actual.

getParameter

public int getParameter()
Obtiene el parámetro asociado al nodo.

Returns:
Parámetro asociado al nodo.

getParentNode

public RtfTreeNode getParentNode()
Obtiene el nodo padre del nodo actual.

Returns:
Nodo padre del nodo actual.

getRootNode

public RtfTreeNode getRootNode()
Obtiene el nodo raíz del árbol RTF.

Returns:
Nodo raíz del árbol RTF.

getRtf

public java.lang.String getRtf()
Devuelve el código RTF del nodo actual y todos sus nodos hijos.

Returns:
Código RTF del nodo actual y todos sus nodos hijos.

hasChildNodes

public boolean hasChildNodes()
Indica si el nodo actual tiene nodos hijos.

Returns:
Devuelve true si el nodo actual tiene algún nodo hijo.

lastChild

public RtfTreeNode lastChild()
Obtiene el último nodo hijo del nodo actual.

Returns:
Último nodo hijo del nodo actual.

nextSibling

public RtfTreeNode nextSibling()
Obtiene el nodo hermano siguiente del nodo actual (Dos nodos son hermanos si tienen el mismo nodo padre [ParentNode]).

Returns:
Siguiente nodo hermano del nodo actual.

previousSibling

public RtfTreeNode previousSibling()
Obtiene el nodo hermano anterior del nodo actual (Dos nodos son hermanos si tienen el mismo nodo padre [ParentNode]).

Returns:
Nodo hermano anterior del nodo actual.

removeChild

public void removeChild(int index)
Elimina un nodo de la lista de hijos.

Parameters:
index - Indice del nodo a eliminar.

removeChild

public void removeChild(RtfTreeNode node)
Elimina un nodo de la lista de hijos.

Parameters:
node - Nodo a eliminar.

selectChildNodes

public RtfNodeCollection selectChildNodes(java.lang.String keyword)
Devuelve todos los nodos de la lista de nodos hijos del nodo actual cuya palabra clave es la indicada como parámetro.

Parameters:
keyword - Palabra clave buscada.
Returns:
Colección de nodos de la lista de nodos hijos del nodo actual cuya palabra clave es la indicada como parámetro.

selectChildNodesByType

public RtfNodeCollection selectChildNodesByType(int nodeType)
Devuelve todos los nodos de la lista de nodos hijos del nodo actual cuyo tipo es el indicado como parámetro.

Parameters:
nodeType - Tipo del nodo buscado.
Returns:
Colección de nodos de la lista de nodos hijos del nodo actual cuyo tipo es el indicado como parámetro.

selectNodes

public RtfNodeCollection selectNodes(java.lang.String keyword)
Devuelve todos los nodos, a partir del nodo actual, cuya palabra clave es la indicada como parámetro.

Parameters:
keyword - Palabra clave buscada.
Returns:
Colección de nodos, a partir del nodo actual, cuya palabra clave es la indicada como parámetro.

selectNodesByType

public RtfNodeCollection selectNodesByType(int nodeType)
Devuelve todos los nodos, a partir del nodo actual, cuyo tipo es el indicado como parámetro.

Parameters:
nodeType - Tipo del nodo buscado.
Returns:
Colección de nodos, a partir del nodo actual, cuyo tipo es la indicado como parámetro.

selectSingleChildNode

public RtfTreeNode selectSingleChildNode(java.lang.String keyword)
Devuelve el primer nodo de la lista de nodos hijos del nodo actual cuya palabra clave es la indicada como parámetro.

Parameters:
keyword - Palabra clave buscada.
Returns:
Primer nodo de la lista de nodos hijos del nodo actual cuya palabra clave es la indicada como parámetro.

selectSingleChildNodeByType

public RtfTreeNode selectSingleChildNodeByType(int nodeType)
Devuelve el primer nodo de la lista de nodos hijos del nodo actual cuyo tipo es el indicado como parámetro.

Parameters:
nodeType - Tipo de nodo buscado.
Returns:
Primer nodo de la lista de nodos hijos del nodo actual cuyo tipo es el indicado como parámetro.

selectSingleNode

public RtfTreeNode selectSingleNode(java.lang.String keyword)
Devuelve el primer nodo del árbol, a partir del nodo actual, cuya palabra clave es la indicada como parámetro.

Parameters:
keyword - Palabra clave buscada.
Returns:
Primer nodo del árbol, a partir del nodo actual, cuya palabra clave es la indicada como parámetro.

selectSingleNodeByType

public RtfTreeNode selectSingleNodeByType(int nodeType)
Devuelve el primer nodo del árbol, a partir del nodo actual, cuyo tipo es el indicado como parámetro.

Parameters:
nodeType - Tipo del nodo buscado.
Returns:
Primer nodo del árbol, a partir del nodo actual, cuyo tipo es el indicado como parámetro.

setChildNodes

public void setChildNodes(RtfNodeCollection children)
Establece la colección de nodos hijo del nodo actual.

Parameters:
children - Colección de nodos hijo del nodo actual.

setHasParamenter

public void setHasParamenter(boolean hasParam)
Establece el indicativo de existencia de parámetro asociado al nodo.

Parameters:
hasParam - Indicativo de existencia de parámetro asociado al nodo.

setNodeKey

public void setNodeKey(java.lang.String key)
Establece la clave del nodo actual.

Parameters:
key - Clave del nodo.

setNodeType

public void setNodeType(int nodeType)
Establece el tipo de nodo actual.

Parameters:
nodeType - Tipo de nodo.

setParameter

public void setParameter(int param)
Establece el parámetro asociado al nodo.

Parameters:
param - Parámetro asociado al nodo.

setParentNode

public void setParentNode(RtfTreeNode node)
Establece el nodo padre del nodo actual.

Parameters:
node - Nodo padre del nodo actual.

setRootNode

public void setRootNode(RtfTreeNode node)
Establece el nodo raíz del árbol RTF.

Parameters:
node - Nodo raíz del árbol RTF.