Class: SMap_Layer_Zoom

Source Location: /SMap/Layer.php

Class SMap_Layer_Zoom

Class Overview

Navigational elements for zooming in on an image

This object can also be used to create the URL for zooming out.

SMap_Layer
   |
   --SMap_Layer_Zoom

Properties

$controlEnabled

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From SMap_Layer

SMap_Layer::$id

SMap_Layer::$map

Inherited From SMap_Layer

SMap_Layer::__construct()

Construct the layer

SMap_Layer::cacheStatus()

How cachable is this layer?

SMap_Layer::getAdjViewBounds()

Adjust the view coords if we are in an image

SMap_Layer::getID()

Returns the ID of this layer

SMap_Layer::getImageFmt()

Recommended format for this layer

SMap_Layer::getImgObjs()

Composite this layer onto the tile (in a raster way)

SMap_Layer::getMap()

Return the map that contains this layer

SMap_Layer::getMapObjs()

Composite this layer onto the tile

SMap_Layer::hasCachedRects()

Might have cached rects in the DB

SMap_Layer::isValidZoom()

Is this layer zoomed to a useful resolution?

SMap_Layer::pxOffBound()

Get the bound at a pixel offset from a bound.

[ Top ]

Property Summary

mixed

$controlEnabled

Which views is the control enabled on?

[ Top ]

Method Summary

void	enableControlOn()	Turn the zoom controls on for a given view
array	getControlObjs()	Create the zoom control objects
array	getImgObjs()	This has no image elements
array	getMapObjs()	Create a default element for zooming into the area clicked
string	getZoomOutURL()	Create a URL sutible for zooming out
string	getZoomURL()	Create a zoom URL
boolean	hasCachedRects()	The zooming layer has no cached rects
string	redirMap()	Zoom in from a click on the map

[ Top ]

Properties

mixed $controlEnabled = array() [line 1370]

Which views is the control enabled on?

API Tags:

Access:

protected

[ Top ]

Methods

enableControlOn [line 1380]

void enableControlOn(
SMap_View
$view 
)

Turn the zoom controls on for a given view

The default is to apply the controls to all views, but if you want to limit the views which draw the controls, enable them here.

Parameters:

object View

$view:

to draw zoom controls on

API Tags:

Access:

public

[ Top ]

getControlObjs [line 1442]

array getControlObjs(
SMap_View
$view, SMap_Tile
$tile, boolean
$isImg 
)

Create the zoom control objects

Use enableControlOn() to select a specific view to draw the zoom controls on. Otherwise, controls are drawn on all views this object is applied to.

Parameters:

object View	$view:	to draw controls on
object Tile	$tile:	to draw controls in
boolean	$isImg:	Do we need calculations for an image or page?

API Tags:

Return:	Drawing objects
Access:	protected

[ Top ]

getImgObjs [line 1573]

array getImgObjs(
SMap_View
$view, SMap_Tile
$tile 
)

This has no image elements

Parameters:

object	$view:
object	$tile:

API Tags:

Return:	Nothing
Access:	public

Redefinition of:

SMap_Layer::getImgObjs(): Composite this layer onto the tile (in a raster way)

[ Top ]

getMapObjs [line 1547]

array getMapObjs(
SMap_View
$view, SMap_Tile
$tile 
)

Create a default element for zooming into the area clicked

Parameters:

object Containing	$view:	view
object Containing	$tile:	tile

API Tags:

Return:	Objects
Access:	public
Uses:	SMap_Form::getPageLink()

Redefinition of:

SMap_Layer::getMapObjs(): Composite this layer onto the tile

[ Top ]

getZoomOutURL [line 1416]

string getZoomOutURL(
)

Create a URL sutible for zooming out

API Tags:

Return:	The URL
Access:	public

[ Top ]

getZoomURL [line 1397]

string getZoomURL(
float
$Bx, float
$By, integer
$zoomLev 
)

Create a zoom URL

Uses a center point to create a new URL at a given zoom level.

Parameters:

float	$Bx:	Center X
float	$By:	Center Y
integer	$zoomLev:	Zoom level

API Tags:

Return:	The URL to zoom
Access:	protected
Uses:	SMap_Util::centerBounds()
Uses:	SMap_Form::getPageLink()

[ Top ]

hasCachedRects [line 1611]

boolean hasCachedRects(
)

The zooming layer has no cached rects

API Tags:

Access:

public

Redefinition of:

SMap_Layer::hasCachedRects(): Might have cached rects in the DB

[ Top ]

redirMap [line 1587]

string redirMap(
array
$coords 
)

Zoom in from a click on the map

Zoom in by two levels into the area where the user clicked.

Parameters:

array

$coords:

The coordinates where the user clicked

API Tags:

Return:	Redirect the user to this URL
Access:	public

[ Top ]

Documentation generated on Mon, 09 Apr 2007 18:53:22 -0500 by phpDocumentor 1.3.0

	SMap Layers

[ class tree: SMap ] [ index: SMap ] [ all elements ]