com.softwarefx.chartfx.server.maps
Class VisibleMapRegions

java.lang.Object
  com.softwarefx.chartfx.server.maps.VisibleMapRegions

All Implemented Interfaces:

Iterable<MapRegion>

public class VisibleMapRegions
extends Object
implements Iterable<MapRegion>

Provides access to the VisibleMapRegions object.

The VisibleMapRegions object returns all the MapRegions which are visible in the map at a current level.

Constructor Summary

VisibleMapRegions()

Method Summary

MapRegion	get(int i) Returns the element at the specified position in the VisibleMapRegions.
int	getCount() Returns the number of visible map regions in the map.
Iterator<MapRegion>	iterator() Returns an iterator over the elements in this collection.

Methods inherited from class java.lang.Object

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

Constructor Detail

VisibleMapRegions

public VisibleMapRegions()

Method Detail

get

public MapRegion get(int i)

Returns the element at the specified position in the VisibleMapRegions.

Parameters:

i -

getCount

public int getCount()

Returns the number of visible map regions in the map.

Remarks:

This property will return the number of visible regions in the map.

The Map.getVisibleMapRegions() member of the Map object returns a VisibleMapRegions object.

See Also:

Map.getVisibleMapRegions(), Map

iterator

public Iterator<MapRegion> iterator()

Returns an iterator over the elements in this collection.

Specified by:

iterator in interface Iterable<MapRegion>