fr.paris.lutece.plugins.directory.business
Class MapProvider

java.lang.Object
  extended by fr.paris.lutece.plugins.directory.business.MapProvider
All Implemented Interfaces:
IMapProvider

public class MapProvider
extends java.lang.Object
implements IMapProvider

MapProvider


Constructor Summary
MapProvider()
           
 
Method Summary
 java.lang.String getBackListHtmlCode()
          Gets the html code for list result in Back Office
 java.lang.String getDisplayedName()
          Gets the displayed name
 java.lang.String getFrontHtmlCode()
          Gets the html code for front office
 java.lang.String getFrontListHtmlCode()
          Gets the html code for list result front office
 java.lang.String getHtmlCode()
          Gets the html code
 java.lang.String getKey()
          Gets the key.
 boolean isMapListSupported()
          Defines if map in bo and fo lists is supported
 void setBackListHtmlCode(java.lang.String strBackListHtmlCode)
          Set back list html code
 void setDisplayedName(java.lang.String displayedName)
          Set the displayed name
 void setFrontHtmlCode(java.lang.String strFrontHtmlCode)
          Sets the front html
 void setFrontListHtmlCode(java.lang.String strFrontListHtmlCode)
          Sets the front list html code
 void setHtmlCode(java.lang.String htmlCode)
          Sets the html code
 void setKey(java.lang.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 java.lang.String getKey()
Gets the key. This key must be unique.

Specified by:
getKey in interface IMapProvider
Returns:
the key;

setKey

public void setKey(java.lang.String key)
Sets the key

Parameters:
key - the key

getDisplayedName

public java.lang.String getDisplayedName()
Gets the displayed name

Specified by:
getDisplayedName in interface IMapProvider
Returns:
the displayed name

setDisplayedName

public void setDisplayedName(java.lang.String displayedName)
Set the displayed name

Parameters:
displayedName - the displayed name

getHtmlCode

public java.lang.String getHtmlCode()
Gets the html code

Specified by:
getHtmlCode in interface IMapProvider
Returns:
the html code

setHtmlCode

public void setHtmlCode(java.lang.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 java.lang.String getFrontHtmlCode()
Gets the html code for front office

Specified by:
getFrontHtmlCode in interface IMapProvider
Returns:
the html code

getFrontListHtmlCode

public java.lang.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(java.lang.String strFrontListHtmlCode)
Sets the front list html code

Parameters:
strFrontListHtmlCode - the front list template

setFrontHtmlCode

public void setFrontHtmlCode(java.lang.String strFrontHtmlCode)
Sets the front html

Parameters:
strFrontHtmlCode - the front template

setBackListHtmlCode

public void setBackListHtmlCode(java.lang.String strBackListHtmlCode)
Set back list html code

Parameters:
strBackListHtmlCode - the back list template

getBackListHtmlCode

public java.lang.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


Copyright © 2012 Mairie de Paris. All Rights Reserved.