ilMapGUI Class Reference

User interface class for maps. More...

Inheritance diagram for ilMapGUI:

Collaboration diagram for ilMapGUI:

Public Member Functions
	__construct ()
	setMapId ($a_mapid)
	Set Map ID.
	getMapId ()
	Get Map ID.
	setWidth ($a_width)
	Set Width.
	getWidth ()
	Get Width.
	setHeight ($a_height)
	Set Height.
	getHeight ()
	Get Height.
	setLatitude ($a_latitude)
	Set Latitude.
	getLatitude ()
	Get Latitude.
	setLongitude ($a_longitude)
	Set Longitude.
	getLongitude ()
	Get Longitude.
	setZoom ($a_zoom)
	Set Zoom.
	getZoom ()
	Get Zoom.
	setEnableTypeControl ($a_enabletypecontrol)
	Set Use Map Type Control.
	getEnableTypeControl ()
	Get Use Map Type Control.
	setEnableNavigationControl ($a_enablenavigationcontrol)
	Set Use Navigation Control.
	getEnableNavigationControl ()
	Get Use Navigation Control.
	setEnableUpdateListener ($a_enableupdatelistener)
	Set Activate Update Listener.
	getEnableUpdateListener ()
	Get Activate Update Listener.
	setEnableLargeMapControl ($a_largemapcontrol)
	Set Large Map Control.
	getEnableLargeMapControl ()
	Get Large Map Control.
	setEnableCentralMarker ($a_centralmarker)
	Enable Central Marker.
	getEnableCentralMarker ()
	Get Enable Central Marker.
	addUserMarker ($a_user_id)
	Add user marker.
	getHtml ()
	Get HTML.
	getUserListHtml ()
	Get User List HTML (to be displayed besides the map)

Protected Attributes
	$mapid
	$width = "500px"
	$height = "300px"
	$latitude
	$longitude
	$zoom
	$enabletypecontrol = false
	$enableupdatelistener = false
	$enablenavigationcontrol = false
	$enablelargemapcontrol = false
	$user_marker = array()

Detailed Description

User interface class for maps.

Author

Richard Klees richa.nosp@m.rd.k.nosp@m.lees@.nosp@m.conc.nosp@m.epts-.nosp@m.and-.nosp@m.train.nosp@m.ing..nosp@m.de

Version

$Id$

Definition at line 33 of file class.ilMapGUI.php.

Constructor & Destructor Documentation

ilMapGUI::__construct

(

)

Reimplemented in ilGoogleMapGUI, and ilOpenLayersMapGUI.

Definition at line 47 of file class.ilMapGUI.php.

References $lng, and $tpl.

        {
                global $lng, $tpl;
                        
                $lng->loadLanguageModule("maps");
        }

Member Function Documentation

ilMapGUI::addUserMarker

(

$a_user_id

)

Add user marker.

Parameters

int

$a_user_id

User ID

Definition at line 290 of file class.ilMapGUI.php.

        {
                return $this->user_marker[] = $a_user_id;
        }

ilMapGUI::getEnableCentralMarker

(

)

Get Enable Central Marker.

Returns

boolean Central Marker

Definition at line 280 of file class.ilMapGUI.php.

Referenced by ilOpenLayersMapGUI\getHtml(), and ilGoogleMapGUI\getHtml().

        {
                return $this->centralmarker;
        }

Here is the caller graph for this function:

ilMapGUI::getEnableLargeMapControl

(

)

Get Large Map Control.

Returns

boolean Large Map Control

Definition at line 259 of file class.ilMapGUI.php.

Referenced by ilGoogleMapGUI\getHtml().

        {
                return $this->largemapcontrol;
        }

Here is the caller graph for this function:

ilMapGUI::getEnableNavigationControl

(

)

Get Use Navigation Control.

Returns

boolean Use Navigation Control

Definition at line 217 of file class.ilMapGUI.php.

References $enablenavigationcontrol.

Referenced by ilOpenLayersMapGUI\getHtml(), and ilGoogleMapGUI\getHtml().

        {
                return $this->enablenavigationcontrol;
        }

Here is the caller graph for this function:

ilMapGUI::getEnableTypeControl

(

)

Get Use Map Type Control.

Returns

boolean Use Map Type Control

Definition at line 196 of file class.ilMapGUI.php.

References $enabletypecontrol.

Referenced by ilGoogleMapGUI\getHtml().

        {
                return $this->enabletypecontrol;
        }

Here is the caller graph for this function:

ilMapGUI::getEnableUpdateListener

(

)

Get Activate Update Listener.

Returns

boolean Activate Update Listener

Definition at line 238 of file class.ilMapGUI.php.

References $enableupdatelistener.

Referenced by ilOpenLayersMapGUI\getHtml(), and ilGoogleMapGUI\getHtml().

        {
                return $this->enableupdatelistener;
        }

Here is the caller graph for this function:

ilMapGUI::getHeight

(

)

Get Height.

Returns

string Height

Definition at line 112 of file class.ilMapGUI.php.

References $height.

Referenced by ilOpenLayersMapGUI\getHtml(), and ilGoogleMapGUI\getHtml().

        {
                return $this->height;
        }

Here is the caller graph for this function:

ilMapGUI::getHtml ( )

abstract

Get HTML.

Reimplemented in ilGoogleMapGUI, and ilOpenLayersMapGUI.

ilMapGUI::getLatitude

(

)

Get Latitude.

Returns

string Latitude

Definition at line 133 of file class.ilMapGUI.php.

References $latitude.

Referenced by ilOpenLayersMapGUI\getHtml(), and ilGoogleMapGUI\getHtml().

        {
                return $this->latitude;
        }

Here is the caller graph for this function:

ilMapGUI::getLongitude

(

)

Get Longitude.

Returns

string Longitude

Definition at line 154 of file class.ilMapGUI.php.

References $longitude.

Referenced by ilOpenLayersMapGUI\getHtml(), and ilGoogleMapGUI\getHtml().

        {
                return $this->longitude;
        }

Here is the caller graph for this function:

ilMapGUI::getMapId

(

)

Get Map ID.

Returns

string Map ID

Definition at line 70 of file class.ilMapGUI.php.

References $mapid.

Referenced by ilOpenLayersMapGUI\getHtml(), ilGoogleMapGUI\getHtml(), ilOpenLayersMapGUI\getUserListHtml(), and ilGoogleMapGUI\getUserListHtml().

        {
                return $this->mapid;
        }

Here is the caller graph for this function:

ilMapGUI::getUserListHtml ( )

abstract

Get User List HTML (to be displayed besides the map)

Reimplemented in ilGoogleMapGUI, and ilOpenLayersMapGUI.

ilMapGUI::getWidth

(

)

Get Width.

Returns

string Width

Definition at line 91 of file class.ilMapGUI.php.

References $width.

Referenced by ilOpenLayersMapGUI\getHtml(), and ilGoogleMapGUI\getHtml().

        {
                return $this->width;
        }

Here is the caller graph for this function:

ilMapGUI::getZoom

(

)

Get Zoom.

Returns

int Zoom

Definition at line 175 of file class.ilMapGUI.php.

References $zoom.

Referenced by ilOpenLayersMapGUI\getHtml(), and ilGoogleMapGUI\getHtml().

        {
                return $this->zoom;
        }

Here is the caller graph for this function:

ilMapGUI::setEnableCentralMarker

(

$a_centralmarker

)

Enable Central Marker.

Parameters

boolean

$a_centralmarker

Central Marker

Definition at line 269 of file class.ilMapGUI.php.

        {
                $this->centralmarker = $a_centralmarker;
                return $this;
        }

ilMapGUI::setEnableLargeMapControl

(

$a_largemapcontrol

)

Set Large Map Control.

Parameters

boolean

$a_largemapcontrol

Large Map Control

Definition at line 248 of file class.ilMapGUI.php.

        {
                $this->largemapcontrol = $a_largemapcontrol;
                return $this;
        }

ilMapGUI::setEnableNavigationControl

(

$a_enablenavigationcontrol

)

Set Use Navigation Control.

Parameters

boolean

$a_enablenavigationcontrol

Use Navigation Control

Definition at line 206 of file class.ilMapGUI.php.

        {
                $this->enablenavigationcontrol = $a_enablenavigationcontrol;
                return $this;
        }

ilMapGUI::setEnableTypeControl

(

$a_enabletypecontrol

)

Set Use Map Type Control.

Parameters

boolean

$a_enabletypecontrol

Use Map Type Control

Definition at line 185 of file class.ilMapGUI.php.

        {
                $this->enabletypecontrol = $a_enabletypecontrol;
                return $this;
        }

ilMapGUI::setEnableUpdateListener

(

$a_enableupdatelistener

)

Set Activate Update Listener.

Parameters

boolean

$a_enableupdatelistener

Activate Update Listener

Definition at line 227 of file class.ilMapGUI.php.

        {
                $this->enableupdatelistener = $a_enableupdatelistener;
                return $this;
        }

ilMapGUI::setHeight

(

$a_height

)

Set Height.

Parameters

string

$a_height

Height

Definition at line 101 of file class.ilMapGUI.php.

        {
                $this->height = $a_height;
                return $this;
        }

ilMapGUI::setLatitude

(

$a_latitude

)

Set Latitude.

Parameters

string

$a_latitude

Latitude

Definition at line 122 of file class.ilMapGUI.php.

        {
                $this->latitude = $a_latitude;
                return $this;
        }

ilMapGUI::setLongitude

(

$a_longitude

)

Set Longitude.

Parameters

string

$a_longitude

Longitude

Definition at line 143 of file class.ilMapGUI.php.

        {
                $this->longitude = $a_longitude;
                return $this;
        }

ilMapGUI::setMapId

(

$a_mapid

)

Set Map ID.

Parameters

string

$a_mapid

Map ID

Definition at line 59 of file class.ilMapGUI.php.

        {
                $this->mapid = $a_mapid;
                return $this;
        }

ilMapGUI::setWidth

(

$a_width

)

Set Width.

Parameters

string

$a_width

Width

Definition at line 80 of file class.ilMapGUI.php.

        {
                $this->width = $a_width;
                return $this;
        }

ilMapGUI::setZoom

(

$a_zoom

)

Set Zoom.

Parameters

int

$a_zoom

Zoom

Definition at line 164 of file class.ilMapGUI.php.

        {
                $this->zoom = $a_zoom;
                return $this;
        }

Field Documentation

ilMapGUI::$enablelargemapcontrol = false

protected

Definition at line 44 of file class.ilMapGUI.php.

ilMapGUI::$enablenavigationcontrol = false

protected

Definition at line 43 of file class.ilMapGUI.php.

Referenced by getEnableNavigationControl().

ilMapGUI::$enabletypecontrol = false

protected

Definition at line 41 of file class.ilMapGUI.php.

Referenced by getEnableTypeControl().

ilMapGUI::$enableupdatelistener = false

protected

Definition at line 42 of file class.ilMapGUI.php.

Referenced by getEnableUpdateListener().

ilMapGUI::$height = "300px"

protected

Definition at line 37 of file class.ilMapGUI.php.

Referenced by getHeight().

ilMapGUI::$latitude

protected

Definition at line 38 of file class.ilMapGUI.php.

Referenced by getLatitude().

ilMapGUI::$longitude

protected

Definition at line 39 of file class.ilMapGUI.php.

Referenced by getLongitude().

ilMapGUI::$mapid

protected

Definition at line 35 of file class.ilMapGUI.php.

Referenced by getMapId().

ilMapGUI::$user_marker = array()

protected

Definition at line 45 of file class.ilMapGUI.php.

ilMapGUI::$width = "500px"

protected

Definition at line 36 of file class.ilMapGUI.php.

Referenced by getWidth().

ilMapGUI::$zoom

protected

Definition at line 40 of file class.ilMapGUI.php.

Referenced by getZoom().

---

The documentation for this class was generated from the following file:

• Services/Maps/classes/class.ilMapGUI.php