|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Subset2
and its SubsetFilter
instead
public interface SubsetState
A SubsetState
defines the visible Element
s of a
Subset
. Those elements are either enumerated or determined by an
expression, e.g. a regular expression. To support arbitrary defined
hierarchies of elements it is possible to define several paths for each
visible element. A path describes the location of a visible element and
usually consists of a comma separated list of element identifiers. However,
since a path is of type String
applications may use and store a
different location description, but should not use a colon since it is used
as path delimiter.
Method Summary | |
---|---|
void |
addPath(Element element,
java.lang.String path)
Deprecated. Adds the specified path for the given visible element |
void |
addVisibleElement(Element element,
int position)
Deprecated. Adds the given element to the list of all visible elements. |
void |
addVisibleElment(Element element)
Deprecated. Adds the given element to the list of all visible elements |
boolean |
containsPath(Element element,
java.lang.String path)
Deprecated. Checks if this SubsetState contains the specified path for
the given
|
java.lang.String |
getExpression()
Deprecated. Returns an optional expression to determine the visible elements |
java.lang.String |
getId()
Deprecated. Returns the unique state id. |
java.lang.String |
getName()
Deprecated. Returns an optional name for the state. |
java.lang.String[] |
getPaths(Element element)
Deprecated. Returns all paths for the given Element or null , if
no paths were defined. |
int[] |
getPositions(Element element)
Deprecated. Returns the positions of the given visible element. |
Attribute |
getSearchAttribute()
Deprecated. Returns an attribute field that is used for searching with the regular expression. |
Element[] |
getVisibleElements()
Deprecated. Returns all visible elements. |
boolean |
isVisible(Element element)
Deprecated. Checks if the given is visible within this
SubsetState . |
void |
removeAllVisibleElements()
Deprecated. Convenience method to remove all visible elements |
void |
removePath(Element element,
java.lang.String path)
Deprecated. Removes the specified path for the given visible element. |
void |
removeVisibleElement(Element element)
Deprecated. Removes the given element from the list of all visible elements |
void |
setExpression(java.lang.String expression)
Deprecated. Sets an expression to determine the visible elements |
void |
setName(java.lang.String name)
Deprecated. Sets an optional name, label or description |
void |
setSearchAttribute(Attribute searchAttribute)
Deprecated. Sets the attribute field that is used instead of the element name when filtering with a regular expression |
Method Detail |
---|
java.lang.String getId()
java.lang.String getName()
void setName(java.lang.String name)
name
- a human readable labeljava.lang.String getExpression()
void setExpression(java.lang.String expression)
expression
- a state expression to describe the visible elementsAttribute getSearchAttribute()
void setSearchAttribute(Attribute searchAttribute)
searchAttribute
- field used for filteringElement[] getVisibleElements()
Note: the array could be empty but that does not necessarily mean that no element is visible because an expression can determine the elements too.
void addVisibleElment(Element element)
element
- the element to showvoid addVisibleElement(Element element, int position)
element
- the element to showposition
- an element positionvoid removeVisibleElement(Element element)
element
- the element to removevoid removeAllVisibleElements()
java.lang.String[] getPaths(Element element)
Element
or null
, if
no paths were defined. An element path consists of a comma separated list
of element ids. Since an element can be referenced several times,
multiple paths are possible.
element
- a visible element
null
void addPath(Element element, java.lang.String path)
element
- a visible elementpath
- a path to the visible elementboolean containsPath(Element element, java.lang.String path)
SubsetState
contains the specified path for
the given Element
element
- a visible elementpath
- a valid path to the visible element
true
if the path is known for the given element,
false
otherwisevoid removePath(Element element, java.lang.String path)
element
- a visible elementpath
- the path to removeint[] getPositions(Element element)
element
- a visible element
boolean isVisible(Element element)
Element
is visible within this
SubsetState
.
element
- the Element
to check
true
if it is visible, false
otherwise
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |