Interface PubChooserProvider
-
- All Known Implementing Classes:
AbstractPubChooserProvider,BasicSubChooserProvider
public interface PubChooserProvider
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description booleanaccept()Returns true if the menu should propose this itemPubChooserContextgetContext()Returns thePubChooserContextjava.lang.StringgetIcon()Returns the icon of the menu itemjava.lang.StringgetJsp()Returns the jsp of the body of the menu itemjava.lang.StringgetKey()Returns the provider key (from props)java.lang.StringgetLabel()Return the label used in the menu.java.util.List<PubChooserProvider>getSubProviders()Returns a list of sub providers (This will replace the current provider by this list)booleantextSearchEnabled()Returns true if text search should be displayed
-
-
-
Method Detail
-
accept
boolean accept()
Returns true if the menu should propose this item- Returns:
- true if the menu should propose this item
- Since:
- jcms-10.0.8
-
getLabel
java.lang.String getLabel()
Return the label used in the menu.- Returns:
- the label used in the menu.
- Since:
- jcms-10.0.8
-
getIcon
java.lang.String getIcon()
Returns the icon of the menu item- Returns:
- the icon of the menu item
- Since:
- jcms-10.0.8
-
getJsp
java.lang.String getJsp()
Returns the jsp of the body of the menu item- Returns:
- the jsp of the body of the menu item
- Since:
- jcms-10.0.8
-
getContext
PubChooserContext getContext()
Returns thePubChooserContext- Returns:
- the
PubChooserContext - Since:
- jcms-10.0.8
-
textSearchEnabled
boolean textSearchEnabled()
Returns true if text search should be displayed- Returns:
- true if text search should be displayed
- Since:
- jcms-10.0.8
-
getSubProviders
java.util.List<PubChooserProvider> getSubProviders()
Returns a list of sub providers (This will replace the current provider by this list)- Returns:
- a list of sub providers (This will replace the current provider by this list)
- Since:
- jcms-10.0.8
-
getKey
java.lang.String getKey()
Returns the provider key (from props)- Returns:
- the provider key (from props)
- Since:
- jcms-10.0.8
-
-