Package org.ametys.odf.tree

Class AbstractStaticODFTreeIndicator

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.core.ui.StaticFileImportsClientSideElement

org.ametys.odf.tree.AbstractStaticODFTreeIndicator

All Implemented Interfaces:

ClientSideElement, ODFTreeIndicator, LogEnabled, PluginAware, Prioritizable, Configurable, Serviceable

Direct Known Subclasses:

CourseListTypeIndicator, CourseStepHolderIndicator, NotPublishableIndicator, ProgramItemCodeIndicator, SharedCoursePartIndicator, ShareStatusIndicator, WorkflowStepIndicator

public abstract class AbstractStaticODFTreeIndicator
extends StaticFileImportsClientSideElement
implements ODFTreeIndicator

Abstract class for a static ODFTreeIndicator

Nested Class Summary

Nested classes/interfaces inherited from interface org.ametys.core.ui.ClientSideElement

ClientSideElement.Script, ClientSideElement.ScriptFile

Nested classes/interfaces inherited from interface org.ametys.odf.tree.ODFTreeIndicator

ODFTreeIndicator.IndicatorData

Field Summary

Fields inherited from class org.ametys.core.ui.StaticFileImportsClientSideElement

_currentUserProvider, _dependencies, _featureName, _id, _pluginName, _rightManager, _rights, _rightsMode, _script

Constructor Summary

Constructors

Constructor	Description
AbstractStaticODFTreeIndicator()

Method Summary

Modifier and Type	Method	Description
void	configure(Configuration configuration)
String	getApplyJSFunction()	Get the JS function to display the indicator.
I18nizableText	getDescription()	Get the indicator description
String	getIconGlyph()	The indicator glyph icon
I18nizableText	getLabel()	Get the indicator label
String	getMatchJSFunction()	Get the JS function to determines if indicator is available for a content.
int	getPriority()	Get the priority for the component.

Methods inherited from class org.ametys.core.ui.StaticFileImportsClientSideElement

_configureDependencies, _configureImports, _configureRights, _configureRightsMode, _configureScript, getDependencies, getId, getPluginName, getRights, getScripts, getScripts, hasRight, service, setPluginInfo, toString

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ametys.odf.tree.ODFTreeIndicator

getId, getIndicatorData, getScripts

Constructor Details

AbstractStaticODFTreeIndicator

public AbstractStaticODFTreeIndicator()

Method Details

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Overrides:

configure in class StaticFileImportsClientSideElement

Throws:

ConfigurationException

getPriority

public int getPriority()

Description copied from interface: Prioritizable

Get the priority for the component. On components using Prioritizable interface, each implementation define the order. In most cases, less is the number, more prior is the component.

Specified by:

getPriority in interface Prioritizable

Returns:

the priority

getLabel

public I18nizableText getLabel()

Description copied from interface: ODFTreeIndicator

Get the indicator label

Specified by:

getLabel in interface ODFTreeIndicator

Returns:

the label

getDescription

public I18nizableText getDescription()

Description copied from interface: ODFTreeIndicator

Get the indicator description

Specified by:

getDescription in interface ODFTreeIndicator

Returns:

the description

getIconGlyph

public String getIconGlyph()

Description copied from interface: ODFTreeIndicator

The indicator glyph icon

Specified by:

getIconGlyph in interface ODFTreeIndicator

Returns:

the CSS class for glyph icon

getMatchJSFunction

public String getMatchJSFunction()

Description copied from interface: ODFTreeIndicator

Get the JS function to determines if indicator is available for a content. Can return null to use default one.

Specified by:

getMatchJSFunction in interface ODFTreeIndicator

Returns:

the JS function or null to use default matcher

getApplyJSFunction

public String getApplyJSFunction()

Description copied from interface: ODFTreeIndicator

Get the JS function to display the indicator. Can return null to use default one.

Specified by:

getApplyJSFunction in interface ODFTreeIndicator

Returns:

the JS function or null to use default applyier