|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.palo.api.subsets.filter.settings.AbstractFilterSettings
org.palo.api.subsets.filter.settings.HierarchicalFilterSetting
public class HierarchicalFilterSetting
HierarchicalFilterSetting
Manages the settings for the HierarchicalFilter
.
Field Summary | |
---|---|
static int |
HIDE_MODE_CONSOLIDATIONS
|
static int |
HIDE_MODE_DISABLED
|
static int |
HIDE_MODE_LEAFS
|
static int |
REVOLVE_ADD_ABOVE
|
static int |
REVOLVE_ADD_BELOW
|
static int |
REVOLVE_ADD_DISABLED
|
Constructor Summary | |
---|---|
HierarchicalFilterSetting()
|
Method Summary | |
---|---|
void |
adapt(FilterSetting from)
Adapt the filter setting from the given filter setting. |
void |
bind(Subset2 subset)
Binds this filter settings instance to the given Subset2
NOTE: PLEASE DON'T USE! |
boolean |
doAboveBelowSelection()
Checks if a reference element is specified for above/below selection |
boolean |
doHide()
Checks if hide mode is active |
boolean |
doLevelSelection()
Checks if start or end elements are specified for level selection |
boolean |
doRevolve()
Checks if a revolve element is specified. |
BooleanParameter |
getAbove()
Checks if all elements above the reference element should be used for above/below selection |
StringParameter |
getEndElement()
Deprecated. please use getEndLevel() |
IntegerParameter |
getEndLevel()
Returns the end level for selection based on element level |
BooleanParameter |
getExclusive()
Checks if reference element should be considered for above/below selection too |
IntegerParameter |
getHideMode()
Returns the hide mode to use, i.e. one of the predefined hide mode constants |
StringParameter |
getRefElement()
Returns the identifier of the specified reference element for above/below selection |
IntegerParameter |
getRevolveCount()
Returns the number of elements to take for revolve selection |
StringParameter |
getRevolveElement()
Returns the identifier of the specified revolve element for revolve selection |
IntegerParameter |
getRevolveMode()
Returns the revolve mode, i.e. one of the predefined revolve mode constants |
StringParameter |
getStartElement()
Deprecated. please use getStartLevel() |
IntegerParameter |
getStartLevel()
Returns the start level for selection based on element level |
void |
reset()
Resets the filter setting to its defaults. |
void |
setAbove(boolean above)
Specifies if all elements above the reference element should be used for above/below selection |
void |
setAbove(BooleanParameter above)
Specifies if all elements above the reference element should be included in selection |
void |
setEndElement(java.lang.String elementId)
Deprecated. please use setEndLevel(int) |
void |
setEndElement(StringParameter element)
Deprecated. please use setEndLevel(IntegerParameter) |
void |
setEndLevel(int level)
Sets the end level for selection based on element level |
void |
setEndLevel(IntegerParameter level)
Sets the end level for selection based on element level |
void |
setExclusive(boolean exclusive)
Specifies if reference element should be considered for above/below selection too |
void |
setExclusive(BooleanParameter exclusive)
Specifies if the reference element should be included or excluded in the selection |
void |
setHideMode(int hideMode)
Sets the hide mode. |
void |
setHideMode(IntegerParameter hideMode)
Sets the hide mode. |
void |
setRefElement(java.lang.String elementId)
Sets the identifier of the reference element for above/below selection |
void |
setRefElement(StringParameter element)
Sets the identifier of the reference element for above/below selection, i.e. the parameter value should contain the id of the reference element. |
void |
setRevolveCount(int revolveElementsCount)
Specifies the number of elements to take for revolve selection |
void |
setRevolveCount(IntegerParameter revolveElementsCount)
Sets the revolve count, i.e. the parameter value should contain the number of elements to take for revolve selection |
void |
setRevolveElement(java.lang.String elementId)
Sets the identifier of the revolve element for revolve selection |
void |
setRevolveElement(StringParameter elementId)
Sets the identifier of the revolve element for revolve selection, i.e. the parameter value should contain the id of the revolve element. |
void |
setRevolveMode(int revolveMode)
Sets the revolve mode. |
void |
setRevolveMode(IntegerParameter revolveMode)
Sets the revolve mode, i.e. the parameter value should be one of the predefined revolve mode constants |
void |
setStartElement(java.lang.String elementId)
Deprecated. please use setStartLevel(int) |
void |
setStartElement(StringParameter element)
Deprecated. please use setStartLevel(IntegerParameter) |
void |
setStartLevel(int level)
Sets the start level for selection based on element level |
void |
setStartLevel(IntegerParameter level)
Sets the start level for selection based on element level |
void |
unbind()
Releases this filter settings instance from a previously binded Subset2
NOTE: PLEASE DON'T USE! |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int HIDE_MODE_DISABLED
public static final int HIDE_MODE_LEAFS
public static final int HIDE_MODE_CONSOLIDATIONS
public static final int REVOLVE_ADD_DISABLED
public static final int REVOLVE_ADD_BELOW
public static final int REVOLVE_ADD_ABOVE
Constructor Detail |
---|
public HierarchicalFilterSetting()
Method Detail |
---|
public final void reset()
FilterSetting
public final boolean doAboveBelowSelection()
true
if a reference element is specified,
false
otherwisepublic final boolean doLevelSelection()
true
if either a start or an end element is
specified, false
otherwisepublic final boolean doHide()
true
if a hide mode should be used,
false
otherwisepublic final boolean doRevolve()
true
if a revolve element is specified,
false
otherwisepublic final StringParameter getRefElement()
public final void setRefElement(java.lang.String elementId)
elementId
- the reference elementpublic final void setRefElement(StringParameter element)
element
- the new StringParameter
to use for the
above/below selectionpublic final BooleanParameter getAbove()
true
if all elements above reference element should
be used, false
otherwisepublic final void setAbove(boolean above)
above
- set to true
if all elements above reference
elements should be used, to false
otherwisepublic final void setAbove(BooleanParameter above)
above
- public final BooleanParameter getExclusive()
true
if reference element should not be considered
too, false
otherwisepublic final void setExclusive(boolean exclusive)
exclusive
- set to true
to exclude reference element,
to false
to include itpublic final void setExclusive(BooleanParameter exclusive)
exclusive
- public final IntegerParameter getHideMode()
public final void setHideMode(int hideMode)
hideMode
- the new hide modepublic final void setHideMode(IntegerParameter hideMode)
hideMode
- the new IntegerParameter
to use for
the hide modepublic final IntegerParameter getStartLevel()
public final void setStartLevel(int level)
level
- the start levelpublic final void setStartLevel(IntegerParameter level)
level
- the start levelpublic final IntegerParameter getEndLevel()
public final void setEndLevel(int level)
level
- the end levelpublic final void setEndLevel(IntegerParameter level)
level
- the end levelpublic final StringParameter getStartElement()
getStartLevel()
public final void setStartElement(java.lang.String elementId)
setStartLevel(int)
elementId
- the start elementpublic final void setStartElement(StringParameter element)
setStartLevel(IntegerParameter)
element
- the new StringParameter
to use as start
element for the level selectionpublic final StringParameter getEndElement()
getEndLevel()
public final void setEndElement(java.lang.String elementId)
setEndLevel(int)
elementId
- the end elementpublic final void setEndElement(StringParameter element)
setEndLevel(IntegerParameter)
element
- the new StringParameter
to use as end
element for the level selectionpublic final StringParameter getRevolveElement()
public final void setRevolveElement(java.lang.String elementId)
elementId
- the revolve elementpublic final void setRevolveElement(StringParameter elementId)
element
- the new StringParameter
to use as revolve
element for revolve selectionpublic final IntegerParameter getRevolveCount()
public final void setRevolveCount(int revolveElementsCount)
revolveElementsCount
- the new revolve countpublic final void setRevolveCount(IntegerParameter revolveElementsCount)
revolveElementsCount
- the new IntegerParameter
to use
as revolve countpublic final IntegerParameter getRevolveMode()
public final void setRevolveMode(int revolveMode)
revolveMode
- the new revolve modepublic final void setRevolveMode(IntegerParameter revolveMode)
revolveMode
- the new IntegerParameter
to use for
revolve modepublic final void bind(Subset2 subset)
FilterSetting
Binds this filter settings instance to the given Subset2
bind
in interface FilterSetting
bind
in class AbstractFilterSettings
public final void unbind()
FilterSetting
Releases this filter settings instance from a previously binded
Subset2
unbind
in interface FilterSetting
unbind
in class AbstractFilterSettings
public final void adapt(FilterSetting from)
FilterSetting
from
- the filter setting to adapt from
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |