no.sesat.search.view.navigation
Class TreeNavigationConfig

java.lang.Object
  no.sesat.search.view.navigation.NavigationConfig.Nav
      no.sesat.search.view.navigation.TreeNavigationConfig

All Implemented Interfaces:

Serializable

@NavigationConfig.Nav.ControllerFactory(value="no.sesat.search.view.navigation.TreeNavigationController$Factory")
public class TreeNavigationConfig
extends NavigationConfig.Nav

This class represent a tree element in the views.xml file. Usage: ...

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class no.sesat.search.view.navigation.NavigationConfig.Nav

NavigationConfig.Nav.ControllerFactory

Constructor Summary

TreeNavigationConfig(NavigationConfig.Nav parent, NavigationConfig.Navigation navigation, Element navElement)

Method Summary

String	getName()
String	getParametersToKeep() Return the parameters that we want to keep, this could be parameters from some navigators that we run in parallel.
Set<String>	getResetParameter()
String	getValue() If not specified the name will be used as default.
boolean	isHideParameter() If this element should hide it's parameter or not.
void	setHideParameter(boolean hideParameter) Set if this element should hide it's parameter.
void	setName(String name)
void	setParametersToKeep(String parametersToKeep) Set the parameters that we want to keep.
void	setValue(String value) If not specified the name will be used as default.

Methods inherited from class no.sesat.search.view.navigation.NavigationConfig.Nav

addChild, getBackText, getChildNavs, getCommandName, getField, getId, getMaxsize, getNavigation, getParent, getStaticParameters, getTab, isAutoNavigation, isOut, isVirtual, setAutoNavigation, setBackText, setCommandName, setField, setId, setMaxsize, setOut, setStaticParameters, setTab, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

TreeNavigationConfig

public TreeNavigationConfig(NavigationConfig.Nav parent,
                            NavigationConfig.Navigation navigation,
                            Element navElement)

Parameters:

parent - The parent

navigation - The navigation

navElement -

Method Detail

getName

public String getName()

Returns:

name

setName

public void setName(String name)

Parameters:

name - Name used when displaying this element.

getValue

public String getValue()

If not specified the name will be used as default.

Returns:

Value used for parameter

setValue

public void setValue(String value)

If not specified the name will be used as default.

Parameters:

value - Value used for parameter.

getResetParameter

public Set<String> getResetParameter()

Returns:

Set of parameter names that should be reset when generating url

isHideParameter

public boolean isHideParameter()

If this element should hide it's parameter or not. Default is false.

Returns:

true if this element should not generate a parameter.

setHideParameter

public void setHideParameter(boolean hideParameter)

Set if this element should hide it's parameter. If this is true, then the elements field and value will be skipped when generating url.

Parameters:

hideParameter -

getParametersToKeep

public String getParametersToKeep()

Return the parameters that we want to keep, this could be parameters from some navigators that we run in parallel.

Returns:

String of parameters that we want to keep. The string is comma separated.

setParametersToKeep

public void setParametersToKeep(String parametersToKeep)

Set the parameters that we want to keep. The list is represented with a comma separated string. Parameters that we want to keep could be parameters from other navigators like a sort navigator.

Parameters:

parametersToKeep -