Class: SMap_Form

Once the form variables are deciphered, they are set here. After object construction, the final value of the form's values should be stored here. When in doubt, use these values.

Set so the mapping vars don't collide with anything else. Altering this will theoretically allow people to place more than one map on a page without them interfering with eachother.

Note that there are static variables in the layout engine that may collide, so exercise caution.

Set when we will be drawing the image for a single tile. The process is normally that a script pretends to be

All values set here are permanently set. For example, if you want a view to always be shown, set its ID in here. Same thing for layer(s).

Use whatever method you wish to place the appropriate request in this array.

http://www.phpclasses.org/browse/package/3465.html

Adds a set of checkboxes or radio buttons to a given SForm container. The container can be a group, fieldset, form, or whatever. The element definitions define the id of each layer or view as the keys, and the element's label as the values. The status of the elements is an array of the currently enabled id's.

If $sel is used the set turns dynamic. Elements selected by $sel appear in the checked list. Elements that are unchecked dissappear from the checked list, but reappear in $sel.

Sets up the correct structure of the SForm with the correct defaults, elements, values, etc.

This is one of the few methods that uses the raw query string to parse out the location that the user clicked on the tile.

The link view is a view that doesn't use images, all links that would otherwise be in the images are simply presented as links in a table (or whatever the template dictates). The link view is useful for accessibility and search engine reasons. Without a link view, a search engine couldn't crawl the map or a person with disabilities use the map. I'm not saying that it's easy to use the map using only the links in the table, but at least it's possible.

Expects a fully layered set and an array describing the current cell (see also getCurrentCell()). Also expects the view ID to determine which view we expect to be looking at. This can be useful if different view IDs have different templates, or whatever.

Returns the XHTML for the form + view templates.

(note: This has not been used yet.)

The map view is a view with a set of arranged images of tiles. There are actions that can happen by clicking on each tile, those are determined by the layers that are passed in (zooming in would be a common one). The user can also pan the view around the view. Any actions that involve clicking on the view are handled by layers.

Returns the XHTML for the form + view templates.

$array[$optionValue] = array($pixelsWide, $pixelsHigh, $forPrint)

This returns the positioning information array that should represent either. The positioning information includes positioning info ['tileGrid'] and view ID ['viewId']. Also included is ['isTile'], which defines if the map is being drawn as a single tile (as opposed to a set of tiles).

The tile grid is an array of integers with keys at SMap_Tile::POSX, VIEWX, POSY, VIEWY. The array describes the position of the tile that we are viewing in relation to the other tiles. It contains enough information to determine which edge a tile is on.

The position 1,1 is the tile in the upper left. If the view is 7 tiles wide and 4 tiles high then the numbers in VIEWX and VIEWY will be 7 and 4 respectively. The tile in the upper right corner will be at position 7,1.

The tile grid is optional. If a tile has no need to know it's position relative to the other tiles, then it shouldn't be used. Most tiles should be able to do just fine by just using the bounds. If the grid is not defined, then the grid contains only VIEWX and VIEWY.

Uses the SForm to construct an appropriate request array from the user's input. If you want to use something other than the SForm, you can always take care of that urge here. Just construct the $request array correctly and you're good to go.