oracle.cabo.ui.path
Class AbstractCompositePath

java.lang.Object
  |
  +--oracle.cabo.ui.path.AbstractCompositePath

All Implemented Interfaces:

java.lang.Cloneable, Path

public abstract class AbstractCompositePath

extends java.lang.Object

implements Path

Abstract Path that combines two paths together

Constructor Summary

AbstractCompositePath()

Method Summary

abstract java.lang.Object	clone() Clones the path.
protected java.lang.Object	cloneHelper()
UINode	followPath(RenderingContext context, UINode from) Follows the entire path.
UINode	followPath(RenderingContext context, UINode from, int start, int depth) Returns the result of partially following the path from a starting node.
int	getElementCount() Returns the number of elements in the path.
int	getElementIndex(int elementIndex) Returns the child index of a path element; returns -1 if that part of the path is a named child.
java.lang.String	getElementName(int elementIndex) Returns the chid name of a path element; returns null if that part of the path is an indexed child.
protected abstract Path	getEndPath() Returns the Path to use as the end of the composite Path
protected abstract Path	getStartPath() Returns the Path to use as the start of the composite Path
boolean	isElementNamed(int elementIndex) Returns true if the element at the given index is a named child, as opposed to an indexed child.
java.lang.String	toString() Returns a string representation of the path.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AbstractCompositePath

public AbstractCompositePath()

Method Detail

getStartPath

protected abstract Path getStartPath()

Returns the Path to use as the start of the composite Path

getEndPath

protected abstract Path getEndPath()

Returns the Path to use as the end of the composite Path

followPath

public UINode followPath(RenderingContext context,
                         UINode from,
                         int start,
                         int depth)

Returns the result of partially following the path from a starting node. Returns null if any of the steps of the path cannot be followed.

Specified by:

followPath in interface Path

Parameters:

from - the node to start from

start - the number of steps in the path to start from; if 0, starts from the beginning. If negative, counts from the end.

depth - the number of steps in the path to follow

followPath

public final UINode followPath(RenderingContext context,
                               UINode from)

Follows the entire path. Returns null if any of the steps of the path cannot be followed.

Specified by:

followPath in interface Path

Parameters:

from - the node to start from

getElementCount

public int getElementCount()

Returns the number of elements in the path.

Specified by:

getElementCount in interface Path

isElementNamed

public boolean isElementNamed(int elementIndex)

Returns true if the element at the given index is a named child, as opposed to an indexed child.

Specified by:

isElementNamed in interface Path

Parameters:

elementIndex - the zero-based index into the path; if negative, counts back from the end of the path

getElementIndex

public int getElementIndex(int elementIndex)

Returns the child index of a path element; returns -1 if that part of the path is a named child.

Specified by:

getElementIndex in interface Path

Parameters:

elementIndex - the zero-based index into the path; if negative, counts back from the end of the path

getElementName

public java.lang.String getElementName(int elementIndex)

Returns the chid name of a path element; returns null if that part of the path is an indexed child.

Specified by:

getElementName in interface Path

Parameters:

elementIndex - the zero-based index into the path; if negative, counts back from the end of the path

toString

public java.lang.String toString()

Returns a string representation of the path.

Overrides:

toString in class java.lang.Object

clone

public abstract java.lang.Object clone()

Description copied from interface: Path

Clones the path.

Specified by:

clone in interface Path

Overrides:

clone in class java.lang.Object

cloneHelper

protected final java.lang.Object cloneHelper()