com.jalios.jcms.categorybrowser

Interface CategoryBrowser

All Known Implementing Classes:

SearchCategoryBrowser

public interface CategoryBrowser

Method Summary

Modifier and Type	Method and Description
boolean	accept(CategoryBrowserContext ctx) Returns true if the Category Browser proposes to browse this cateogy.
java.lang.String	getIcon(CategoryBrowserContext ctx) Returns the icon of the Category Browser.
java.lang.String	getLabel(CategoryBrowserContext ctx) Return the label used in the dropdown menu.
default java.lang.String	getLinkAttributes() Returns HTML attributes to add to the link.
default java.lang.String	getLinkCss() Returns CSS classes to add to the link.
java.lang.String	getUrl(CategoryBrowserContext ctx) Returns the URL to browse the category
default boolean	isExclusive(CategoryBrowserContext ctx) Returns true if this CategoryBrowser must be the only one to be displayed.

Method Detail

accept

boolean accept(CategoryBrowserContext ctx)

Returns true if the Category Browser proposes to browse this cateogy.

Parameters:

ctx - the Category Browser context

Returns:

true if the Category Browser proposes to browse this cateogy.

Since:

jcms-10.0.5

getUrl

java.lang.String getUrl(CategoryBrowserContext ctx)

Returns the URL to browse the category

Parameters:

ctx - the Category Browser context

Returns:

the URL to browse the category

Since:

jcms-10.0.5

getLabel

java.lang.String getLabel(CategoryBrowserContext ctx)

Return the label used in the dropdown menu.

Parameters:

ctx - the Category Browser context

Returns:

the label used in the dropdown menu.

Since:

jcms-10.0.5

getIcon

java.lang.String getIcon(CategoryBrowserContext ctx)

Returns the icon of the Category Browser.

Parameters:

ctx - the Category Browser context

Returns:

the icon of the Category Browser.

Since:

jcms-10.0.5

getLinkCss

default java.lang.String getLinkCss()

Returns CSS classes to add to the link.

Returns:

CSS classes to add to the link.

Since:

jcms-10.0.5

getLinkAttributes

default java.lang.String getLinkAttributes()

Returns HTML attributes to add to the link.

Returns:

HTML attributes to add to the link.

Since:

jcms-10.0.5

isExclusive

default boolean isExclusive(CategoryBrowserContext ctx)

Returns true if this CategoryBrowser must be the only one to be displayed.

Parameters:

ctx - the Category Browser context

Returns:

true if this CategoryBrowser must be the only one to be displayed.

Since:

jcms-10.0.5