|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.palo.api.ext.subsets.SubsetHandlerRegistry
Dimension.getSubsetHandler()
instead!
public class SubsetHandlerRegistry
A SubsetHandlerRegistry
administers SubsetStateHandler
s
which are used to determine the visible Element
s from a certain
Subset
and its SubsetState
. A SubsetStateHandler
should not be used directly to compute the visible elements. Instead the
registry returns a SubsetHandler
which provides convenience
methods for this task.
The API provides three default SubsetStateHandler
s which are
registered already, namely:
FlatState
HierarchicalState
RegExState
Here is a code snippet which shows an example usage of the
SubsetHandlerRegistry
...
SubsetHandlerRegistry handlerReg = SubsetHandlerRegistry.getInstance();
//get visible elements for the currently active SubsetState
Element[] visibleElements = handlerReg.getHandler(aSubset).getVisibleElements();
//get visible elements for a certain SubsetState
visibleElements = handlerReg.getHandler(aSubset,RegExState.ID).getVisibleElements();
...
Method Summary | |
---|---|
SubsetStateHandler[] |
getAllStateHandler()
Deprecated. Returns all registered SubsetStateHandler s |
SubsetHandler |
getHandler(Subset subset)
Deprecated. Returns the SubsetHandler for the given Subset . |
SubsetHandler |
getHandler(Subset subset,
java.lang.String stateId)
Deprecated. Returns the SubsetHandler for the given Subset and
its SubsetState defined by the given id. |
SubsetHandler |
getHandler(Subset subset,
SubsetState subsetState)
Deprecated. Returns the SubsetHandler for the given SubsetState . |
static SubsetHandlerRegistry |
getInstance()
Deprecated. Returns the sole registry instance |
SubsetStateHandler |
getStateHandler(java.lang.String stateId)
Deprecated. Returns the internally used SubsetStateHandler which is
registered under the given subset state id. |
void |
register(java.lang.String stateId,
SubsetStateHandler handler)
Deprecated. Registers the given handler for the SubsetState specified
by given state id. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public static final SubsetHandlerRegistry getInstance()
public final SubsetHandler getHandler(Subset subset)
SubsetHandler
for the given Subset
.
null
is returned if no SubsetHandler
could be
found or if no active SubsetState
is set.
subset
- the Subset
to create the handler for
SubsetHandler
or null
if no handler
could be foundpublic final SubsetHandler getHandler(Subset subset, SubsetState subsetState)
SubsetHandler
for the given SubsetState
.
If no SubsetHandler
could be found null
is
returned.
subset
- the Subset
to create the handler forsubsetState
- the SubsetState
to use
SubsetHandler
or null
if no handler
could be foundpublic final SubsetHandler getHandler(Subset subset, java.lang.String stateId)
SubsetHandler
for the given Subset
and
its SubsetState
defined by the given id.
If no SubsetHandler
could be found null
is
returned.
subset
- the Subset
to create the handler forstateId
- a valid subset state identifier
SubsetHandler
or null
if no handler
could be foundpublic final SubsetStateHandler getStateHandler(java.lang.String stateId)
SubsetStateHandler
which is
registered under the given subset state id. Note: it is not
recommended to use a SubsetStateHandler
directly, rather
utilize the provided getHandler(Subset)
method.
stateId
- as subset state id
public final SubsetStateHandler[] getAllStateHandler()
SubsetStateHandler
s
public final void register(java.lang.String stateId, SubsetStateHandler handler)
SubsetState
specified
by given state id.
id
- handler
-
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |