fr.paris.lutece.portal.service.dashboard

Class DashboardComponent

java.lang.Object

fr.paris.lutece.portal.service.dashboard.DashboardComponent

All Implemented Interfaces:

IDashboardComponent, Localizable, Comparable<IDashboardComponent>

Direct Known Subclasses:

AdminDashboardComponent, SiteDashboardComponent, SystemDashboardComponent, UserHeaderDashboardComponent, UsersDashboardComponent

public abstract class DashboardComponent
extends Object
implements IDashboardComponent

Dashboard Component

Constructor Summary

Constructors

Constructor and Description
DashboardComponent()

Method Summary

Modifier and Type	Method and Description
int	compareTo(IDashboardComponent o) Compare component order
boolean	equals(Object obj)
String	getDescription() Returns a localized description
String	getName() Returns the Name
int	getOrder() Returns the Order
Plugin	getPlugin() Returns the Plugin
String	getRight() Returns the Right
int	getZone() Returns the Zone
int	hashCode()
boolean	isEnabled() Tells if the component is enabled
void	setLocale(Locale locale) Sets the locale
void	setName(String strName) Sets the Name
void	setOrder(int nOrder) Sets the Order
void	setPlugin(Plugin plugin) Sets the Plugin
void	setRight(String strRight) Sets the Right
void	setZone(int nZone) Sets the Zone
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface fr.paris.lutece.portal.service.dashboard.IDashboardComponent

getDashboardData

Constructor Detail

DashboardComponent

public DashboardComponent()

Method Detail

getName

public String getName()

Returns the Name

Specified by:

getName in interface IDashboardComponent

Returns:

The Name

setName

public void setName(String strName)

Sets the Name

Specified by:

setName in interface IDashboardComponent

Parameters:

strName - The Name

getRight

public String getRight()

Returns the Right

Specified by:

getRight in interface IDashboardComponent

Returns:

The Right

setRight

public void setRight(String strRight)

Sets the Right

Specified by:

setRight in interface IDashboardComponent

Parameters:

strRight - The Right

getZone

public int getZone()

Returns the Zone

Specified by:

getZone in interface IDashboardComponent

Returns:

The Zone

setZone

public void setZone(int nZone)

Sets the Zone

Specified by:

setZone in interface IDashboardComponent

Parameters:

nZone - The Zone

getOrder

public int getOrder()

Returns the Order

Specified by:

getOrder in interface IDashboardComponent

Returns:

The Order

setOrder

public void setOrder(int nOrder)

Sets the Order

Specified by:

setOrder in interface IDashboardComponent

Parameters:

nOrder - The Order

getPlugin

public Plugin getPlugin()

Returns the Plugin

Specified by:

getPlugin in interface IDashboardComponent

Returns:

The Plugin

setPlugin

public void setPlugin(Plugin plugin)

Sets the Plugin

Specified by:

setPlugin in interface IDashboardComponent

Parameters:

plugin - The plugin

compareTo

public int compareTo(IDashboardComponent o)

Compare component order

Specified by:

compareTo in interface Comparable<IDashboardComponent>

Parameters:

o - The component to compare to

Returns:

less than 0 if the order is lower, 0 if equals and greater than 0 if higher

isEnabled

public boolean isEnabled()

Tells if the component is enabled

Specified by:

isEnabled in interface IDashboardComponent

Returns:

true if enabled

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

setLocale

public void setLocale(Locale locale)

Sets the locale

Specified by:

setLocale in interface Localizable

Parameters:

locale - The locale

getDescription

public String getDescription()

Description copied from interface: IDashboardComponent

Returns a localized description

Specified by:

getDescription in interface IDashboardComponent

Returns:

a localized description