Interface PubChooserProvider
- All Known Implementing Classes:
AbstractPubChooserProvider,BasicSubChooserProvider
public interface PubChooserProvider
-
Method Summary
Modifier and TypeMethodDescriptionbooleanaccept()Returns true if the menu should propose this itemReturns thePubChooserContextgetIcon()Returns the icon of the menu itemgetJsp()Returns the jsp of the body of the menu itemgetKey()Returns the provider key (from props)getLabel()Return the label used in the menu.Deprecated.sub-providers are not supported by the publication chooser modalbooleanDeprecated.the provider JSP is responsible for its search interface
-
Method Details
-
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
String getLabel()Return the label used in the menu.- Returns:
- the label used in the menu.
- Since:
- jcms-10.0.8
-
getIcon
String getIcon()Returns the icon of the menu item- Returns:
- the icon of the menu item
- Since:
- jcms-10.0.8
-
getJsp
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
Deprecated.the provider JSP is responsible for its search interfaceReturns true if text search should be displayed- Returns:
- true if text search should be displayed
- Since:
- jcms-10.0.8
-
getSubProviders
Deprecated.sub-providers are not supported by the publication chooser modalReturns 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
String getKey()Returns the provider key (from props)- Returns:
- the provider key (from props)
- Since:
- jcms-10.0.8
-