Package com.jalios.jcms.handler.pubchooser.provider

Class AbstractPubChooserProvider

java.lang.Object

com.jalios.jcms.handler.pubchooser.provider.AbstractPubChooserProvider

All Implemented Interfaces:

PubChooserProvider

Direct Known Subclasses:

BasicSubChooserProvider

public abstract class AbstractPubChooserProvider
extends java.lang.Object
implements PubChooserProvider

Field Summary

Fields

Modifier and Type	Field	Description
protected PubChooserContext	ctx

Constructor Summary

Constructors

Constructor	Description
AbstractPubChooserProvider(PubChooserContext ctx)

Method Summary

Modifier and Type	Method	Description
boolean	accept()	Returns true if the menu should propose this item
PubChooserContext	getContext()	Returns the PubChooserContext
java.lang.String	getIcon()	Returns the icon of the menu item
java.lang.String	getJsp()	Returns the jsp of the body of the menu item
java.lang.String	getKey()	Returns the provider key (from props)
java.lang.String	getLabel()	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)
boolean	textSearchEnabled()	Returns true if text search should be displayed

Methods inherited from class java.lang.Object

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

Field Detail

ctx

protected PubChooserContext ctx

Constructor Detail

AbstractPubChooserProvider

public AbstractPubChooserProvider(PubChooserContext ctx)

Method Detail

accept

public boolean accept()

Description copied from interface: PubChooserProvider

Returns true if the menu should propose this item

Specified by:

accept in interface PubChooserProvider

Returns:

true if the menu should propose this item

getLabel

public java.lang.String getLabel()

Description copied from interface: PubChooserProvider

Return the label used in the menu.

Specified by:

getLabel in interface PubChooserProvider

Returns:

the label used in the menu.

getIcon

public java.lang.String getIcon()

Description copied from interface: PubChooserProvider

Returns the icon of the menu item

Specified by:

getIcon in interface PubChooserProvider

Returns:

the icon of the menu item

getJsp

public java.lang.String getJsp()

Description copied from interface: PubChooserProvider

Returns the jsp of the body of the menu item

Specified by:

getJsp in interface PubChooserProvider

Returns:

the jsp of the body of the menu item

getKey

public java.lang.String getKey()

Description copied from interface: PubChooserProvider

Returns the provider key (from props)

Specified by:

getKey in interface PubChooserProvider

Returns:

the provider key (from props)

textSearchEnabled

public boolean textSearchEnabled()

Description copied from interface: PubChooserProvider

Returns true if text search should be displayed

Specified by:

textSearchEnabled in interface PubChooserProvider

Returns:

true if text search should be displayed

getContext

public PubChooserContext getContext()

Description copied from interface: PubChooserProvider

Returns the PubChooserContext

Specified by:

getContext in interface PubChooserProvider

Returns:

the PubChooserContext

getSubProviders

public java.util.List<PubChooserProvider> getSubProviders()

Description copied from interface: PubChooserProvider

Returns a list of sub providers (This will replace the current provider by this list)

Specified by:

getSubProviders in interface PubChooserProvider

Returns:

a list of sub providers (This will replace the current provider by this list)