|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object java.util.AbstractMap<K,V> java.util.HashMap<String,Object> com.endeca.infront.assembler.BasicContentItem com.endeca.infront.cartridge.NavigationContainerConfig
public class NavigationContainerConfig
NavigationContainerHandler
configuration model.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class java.util.AbstractMap |
---|
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V> |
Nested classes/interfaces inherited from interface java.util.Map |
---|
Map.Entry<K,V> |
Constructor Summary | |
---|---|
NavigationContainerConfig()
Creates a NavigationContainerConfig with the following default setting: whyPrecedenceRuleFired = false |
|
NavigationContainerConfig(String pType)
Creates a NavigationContainerConfig with the specified type and the following default setting: whyPrecedenceRuleFired = false |
Method Summary | |
---|---|
String |
getLessLinkText()
Returns display text for 'less' links. |
String |
getMoreLinkText()
Returns display text for 'more' links. |
Map<String,String> |
getRefinementsShown()
Returns a map between dimension IDs and the amount of refinements to show (i.e 123 -> some, 324 -> all) |
String |
getRefinementsShownByDefault()
Returns the amount of refinements to show by default. |
List<String> |
getShowMoreIds()
Deprecated. As of release 3.1.1, replaced by getRefinementsShown() . Returns dimension IDs for which 'More' refinement expansion should happen. |
boolean |
getUseShowMoreIdsParam()
Deprecated. As of release 3.1.1. Returns true if the show more and less actions should use the deprecated showMoreIds parameter. The default value of this property is true. |
boolean |
isWhyPrecedenceRuleFired()
When true, enables the reporting of 'why precedence rule fired' debug information. |
void |
setLessLinkText(String lessLinkText)
Sets display text for 'less' links. |
void |
setMoreLinkText(String moreLinkText)
Sets display text for 'more' links. |
void |
setRefinementsShown(Map<String,String> refinementsShown)
Sets the map between dimension IDs and the amount of refinements to show. |
void |
setRefinementsShownByDefault(String refinementsShownByDefault)
Sets the amount of refinements to show. |
void |
setShowMoreIds(List<String> showMore)
Deprecated. As of release 3.1.1, replaced by getRefinementsShown() . Sets dimension IDs for which 'More' refinement expansion should happen. |
void |
setUseShowMoreIdsParam(boolean useShowMoreIdsParam)
Deprecated. As of release 3.1.1. Sets whether the deprecated showMoreIds or the navigation refinement menu config parameter should be used. If false, the showMoreIds will be ignored and the expand and collapse action will appear in the RefinementMenu . |
void |
setWhyPrecedenceRuleFired(boolean whyPrecedenceRuleFired)
Sets if 'why precedence rule fired' debug information should be enabled. |
Methods inherited from class com.endeca.infront.assembler.BasicContentItem |
---|
getBooleanProperty, getIntProperty, getLongProperty, getType, getTypedProperty, setType |
Methods inherited from class java.util.HashMap |
---|
clear, clone, containsKey, containsValue, entrySet, get, isEmpty, keySet, put, putAll, remove, size, values |
Methods inherited from class java.util.AbstractMap |
---|
equals, hashCode, toString |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface java.util.Map |
---|
clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values |
Constructor Detail |
---|
public NavigationContainerConfig()
public NavigationContainerConfig(String pType)
Method Detail |
---|
@Deprecated public List<String> getShowMoreIds()
getRefinementsShown()
.
@Deprecated public void setShowMoreIds(List<String> showMore)
getRefinementsShown()
.
showMore
- dimension IDs for 'More' refinement expansion, may be null.public boolean isWhyPrecedenceRuleFired()
false
.
Note: in order for debugging information to be returned, debugging must be enabled on
NavigationRequest
. To accomplish
this, specify debugEnabled=true
when instantiating
MdexRequestBroker
.
setWhyPrecedenceRuleFired(boolean)
,
MdexRequestBroker
public void setWhyPrecedenceRuleFired(boolean whyPrecedenceRuleFired)
false
.
Note: in order for debugging information to be returned, debugging must be enabled on
NavigationRequest
. To accomplish
this, specify debugEnabled=true
when instantiating
MdexRequestBroker
.
whyPrecedenceRuleFired
- true to enable 'why precedence rule fired' debug infoisWhyPrecedenceRuleFired()
,
NavigationContainerRequestParamMarshaller
,
MdexRequestBroker
public String getMoreLinkText()
public void setMoreLinkText(String moreLinkText)
moreLinkText
- display text for 'more' links.public String getLessLinkText()
public void setLessLinkText(String lessLinkText)
lessLinkText
- display text for 'less' links.@Deprecated public boolean getUseShowMoreIdsParam()
@Deprecated public void setUseShowMoreIdsParam(boolean useShowMoreIdsParam)
RefinementMenu
.
useShowMoreIdsParam
- whether to use the showMoreIds parameter or notpublic String getRefinementsShownByDefault()
public void setRefinementsShownByDefault(String refinementsShownByDefault)
refinementsShownByDefault
- either "none" or "some"public Map<String,String> getRefinementsShown()
public void setRefinementsShown(Map<String,String> refinementsShown)
refinementsShown
- a map between dimension IDs and the amount of refinements to show.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |