fr.paris.lutece.plugins.document.business.attributes

Class MapProvider

java.lang.Object

fr.paris.lutece.plugins.document.business.attributes.MapProvider

All Implemented Interfaces:

IMapProvider

public class MapProvider
extends Object
implements IMapProvider

MapProvider

Constructor Summary

Constructors

Constructor and Description
MapProvider()

Method Summary

Modifier and Type	Method and Description
String	getBackListHtmlCode() Gets the html code for list result in Back Office
String	getDisplayedName() Gets the displayed name
String	getFrontHtmlCode() Gets the html code for front office
String	getFrontListHtmlCode() Gets the html code for list result front office
String	getHtmlCode() Gets the html code
String	getKey() Gets the key.
Object	getParameter(int nKey) returns the Parameter class contains all the parameters of the map
boolean	isMapListSupported() Defines if map in bo and fo lists is supported
void	setBackListHtmlCode(String strBackListHtmlCode) Set back list html code
void	setDisplayedName(String displayedName) Set the displayed name
void	setFrontHtmlCode(String strFrontHtmlCode) Sets the front html
void	setFrontListHtmlCode(String strFrontListHtmlCode) Sets the front list html code
void	setHtmlCode(String htmlCode) Sets the html code
void	setKey(String key) Sets the key
void	setMapListSupported(boolean bMapListSupported) Set to true if map list is supported, false otherwise
fr.paris.lutece.util.ReferenceItem	toRefItem() Builds a new ReferenceItem for the map provider

Methods inherited from class java.lang.Object

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

Constructor Detail

MapProvider

public MapProvider()

Method Detail

getKey

public String getKey()

Gets the key. This key must be unique.

Specified by:

getKey in interface IMapProvider

Returns:

the key;

setKey

public void setKey(String key)

Sets the key

Parameters:

key - the key

getDisplayedName

public String getDisplayedName()

Gets the displayed name

Specified by:

getDisplayedName in interface IMapProvider

Returns:

the displayed name

setDisplayedName

public void setDisplayedName(String displayedName)

Set the displayed name

Parameters:

displayedName - the displayed name

getHtmlCode

public String getHtmlCode()

Gets the html code

Specified by:

getHtmlCode in interface IMapProvider

Returns:

the html code

setHtmlCode

public void setHtmlCode(String htmlCode)

Sets the html code

Parameters:

htmlCode - the html code

toRefItem

public fr.paris.lutece.util.ReferenceItem toRefItem()

Builds a new ReferenceItem for the map provider

Specified by:

toRefItem in interface IMapProvider

Returns:

the item created.

getFrontHtmlCode

public String getFrontHtmlCode()

Gets the html code for front office

Specified by:

getFrontHtmlCode in interface IMapProvider

Returns:

the html code

getFrontListHtmlCode

public String getFrontListHtmlCode()

Gets the html code for list result front office

Specified by:

getFrontListHtmlCode in interface IMapProvider

Returns:

the html code

setFrontListHtmlCode

public void setFrontListHtmlCode(String strFrontListHtmlCode)

Sets the front list html code

Parameters:

strFrontListHtmlCode - the front list template

setFrontHtmlCode

public void setFrontHtmlCode(String strFrontHtmlCode)

Sets the front html

Parameters:

strFrontHtmlCode - the front template

setBackListHtmlCode

public void setBackListHtmlCode(String strBackListHtmlCode)

Set back list html code

Parameters:

strBackListHtmlCode - the back list template

getBackListHtmlCode

public String getBackListHtmlCode()

Gets the html code for list result in Back Office

Specified by:

getBackListHtmlCode in interface IMapProvider

Returns:

the html code

isMapListSupported

public boolean isMapListSupported()

Defines if map in bo and fo lists is supported

Specified by:

isMapListSupported in interface IMapProvider

Returns:

true if a map can be generated (show on map button), false otherwise.

setMapListSupported

public void setMapListSupported(boolean bMapListSupported)

Set to true if map list is supported, false otherwise

Parameters:

bMapListSupported - the new value

getParameter

public Object getParameter(int nKey)

Description copied from interface: IMapProvider

returns the Parameter class contains all the parameters of the map

Specified by:

getParameter in interface IMapProvider

Returns:

the Parameter