Nested and Inner Type Summary

Modifier and Type	Class and Description
pack-priv static class	Map.CircleRegionContainment Used to test for containment in a circular region.
pack-priv static class	Map.DefaultRegionContainment An implementation that will return true if the x, y location is inside a rectangle defined by origin 0, 0, and width equal to width passed in, and height equal to height passed in.
pack-priv static class	Map.PolygonRegionContainment Used to test for containment in a polygon region.
pack-priv static class	Map.RectangleRegionContainment Used to test for containment in a rectangular region.
pack-priv static interface	Map.RegionContainment Defines the interface used for to check if a point is inside a region.

Modifier and Type	Field and Description
private Vector<AttributeSet>	areaAttributes An array of AttributeSets.
private Vector<Map.RegionContainment>	areas An array of RegionContainments, will slowly grow to match the length of areaAttributes as needed.
private String	name Name of the Map.

Access	Constructor and Description
public	Map()
public	Map(String name)

Method Summary

Modifier and Type	Method and Description
public void	addArea(AttributeSet as) Defines a region of the Map, based on the passed in AttributeSet.
protected Map.RegionContainment	createRegionContainment(AttributeSet attributes) Creates and returns an instance of RegionContainment that can be used to test if a particular point lies inside a region.
protected static int[]	extractCoords(Object stringCoords) Creates and returns an array of integers from the String `stringCoords`.
public AttributeSet	getArea(int x, int y, int width, int height) Returns the AttributeSet that contains the passed in location, `x`, `y`.
public AttributeSet[]	getAreas() Returns the AttributeSets representing the different areas of the Map.
public String	getName() Returns the name of the Map.
public void	removeArea(AttributeSet as) Removes the previously created area.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

areaAttributes	back to summary
private Vector<AttributeSet> areaAttributes An array of AttributeSets.

areas	back to summary
private Vector<Map.RegionContainment> areas An array of RegionContainments, will slowly grow to match the length of areaAttributes as needed.

name	back to summary
private String name Name of the Map.

Map	back to summary
public Map()

Map	back to summary
public Map(String name)

Method Detail

addArea	back to summary
public void addArea(AttributeSet as) Defines a region of the Map, based on the passed in AttributeSet.

createRegionContainment	back to summary
protected Map.RegionContainment createRegionContainment(AttributeSet attributes) Creates and returns an instance of RegionContainment that can be used to test if a particular point lies inside a region.

extractCoords	back to summary
protected static int[] extractCoords(Object stringCoords) Creates and returns an array of integers from the String `stringCoords`. If one of the values represents a % the returned value with be negative. If a parse error results from trying to parse one of the numbers null is returned.

getArea	back to summary
public AttributeSet getArea(int x, int y, int width, int height) Returns the AttributeSet that contains the passed in location, `x`, `y`. `width`, `height` gives the size of the region the map is defined over. If a matching area is found, the AttribueSet for it is returned.

getAreas	back to summary
public AttributeSet[] getAreas() Returns the AttributeSets representing the different areas of the Map.

getName	back to summary
public String getName() Returns the name of the Map.

removeArea	back to summary
public void removeArea(AttributeSet as) Removes the previously created area.

javax.swing.text.html back to summary

pack-priv Class Map.CircleRegionContainment

Class Inheritance

extends Object
implements RegionContainment

java.lang.Object
javax.swing.text.html.Map.CircleRegionContainment

All Implemented Interfaces

javax.swing.text.html.Map.RegionContainment

Used to test for containment in a circular region.

Field Summary

Modifier and Type	Field and Description
pack-priv int	lastHeight Last value of height passed in.
pack-priv int	lastWidth Last value of width passed in.
pack-priv float[]	percentValues Non-null indicates one of the values represents a percent.
pack-priv int	radiusSquared Radius of the circle.
pack-priv int	x X origin of the circle.
pack-priv int	y Y origin of the circle.

Constructor Summary

Access	Constructor and Description
public	CircleRegionContainment(AttributeSet as)

Method Summary

Modifier and Type	Method and Description
public boolean	contains(int x, int y, int width, int height) Implements javax.swing.text.html.Map.RegionContainment.contains. Returns true if the location `x`, `y` falls inside the region defined in the receiver.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

lastHeight	back to summary
pack-priv int lastHeight Last value of height passed in.

lastWidth	back to summary
pack-priv int lastWidth Last value of width passed in.

percentValues	back to summary
pack-priv float[] percentValues Non-null indicates one of the values represents a percent.

radiusSquared	back to summary
pack-priv int radiusSquared Radius of the circle.

x	back to summary
pack-priv int x X origin of the circle.

y	back to summary
pack-priv int y Y origin of the circle.

Constructor Detail

CircleRegionContainment	back to summary
public CircleRegionContainment(AttributeSet as)

Method Detail

contains back to summary

contains	back to summary
public boolean contains(int x, int y, int width, int height) Implements javax.swing.text.html.Map.RegionContainment.contains. Doc from javax.swing.text.html.Map.RegionContainment.contains. Returns true if the location `x`, `y` falls inside the region defined in the receiver. `width`, `height` is the size of the enclosing region.

public boolean contains(int x, int y, int width, int height)

Implements javax.swing.text.html.Map.RegionContainment.contains.

Doc from javax.swing.text.html.Map.RegionContainment.contains.

Returns true if the location x, y falls inside the region defined in the receiver. width, height is the size of the enclosing region.

javax.swing.text.html back to summary

pack-priv Class Map.DefaultRegionContainment

Class Inheritance

extends Object
implements RegionContainment

java.lang.Object
javax.swing.text.html.Map.DefaultRegionContainment

All Implemented Interfaces

javax.swing.text.html.Map.RegionContainment

An implementation that will return true if the x, y location is inside a rectangle defined by origin 0, 0, and width equal to width passed in, and height equal to height passed in.

Field Summary

Modifier and Type	Field and Description
pack-priv static Map.DefaultRegionContainment	si A global shared instance.

Constructor Summary

Access	Constructor and Description
pack-priv	DefaultRegionContainment()

Method Summary

Modifier and Type	Method and Description
public boolean	contains(int x, int y, int width, int height) Implements javax.swing.text.html.Map.RegionContainment.contains. Returns true if the location `x`, `y` falls inside the region defined in the receiver.
public static Map.DefaultRegionContainment	sharedInstance()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

si	back to summary
pack-priv static Map.DefaultRegionContainment si A global shared instance.

Constructor Detail

DefaultRegionContainment	back to summary
pack-priv DefaultRegionContainment()

Method Detail

contains back to summary

contains	back to summary
public boolean contains(int x, int y, int width, int height) Implements javax.swing.text.html.Map.RegionContainment.contains. Doc from javax.swing.text.html.Map.RegionContainment.contains. Returns true if the location `x`, `y` falls inside the region defined in the receiver. `width`, `height` is the size of the enclosing region.

public boolean contains(int x, int y, int width, int height)

Implements javax.swing.text.html.Map.RegionContainment.contains.

Doc from javax.swing.text.html.Map.RegionContainment.contains.

Returns true if the location x, y falls inside the region defined in the receiver. width, height is the size of the enclosing region.

sharedInstance	back to summary
public static Map.DefaultRegionContainment sharedInstance()

javax.swing.text.html back to summary

pack-priv Class Map.PolygonRegionContainment

Class Inheritance

extends Polygon
implements RegionContainment

java.lang.Object
java.awt.Polygon
javax.swing.text.html.Map.PolygonRegionContainment

All Implemented Interfaces

javax.swing.text.html.Map.RegionContainment

Used to test for containment in a polygon region.

Field Summary

Modifier and Type	Field and Description
pack-priv int	lastHeight Last value of height passed in.
pack-priv int	lastWidth Last value of width passed in.
pack-priv int[]	percentIndexs
pack-priv float[]	percentValues If any value is a percent there will be an entry here for the percent value.

Inherited from java.awt.Polygon:: bounds npoints xpoints ypoints

Constructor Summary

Access	Constructor and Description
public	PolygonRegionContainment(AttributeSet as)

Method Summary

Modifier and Type	Method and Description
public boolean	contains(int x, int y, int width, int height) Implements javax.swing.text.html.Map.RegionContainment.contains. Returns true if the location `x`, `y` falls inside the region defined in the receiver.

Inherited from java.awt.Polygon:: addPoint contains contains contains contains contains contains getBoundingBox getBounds getBounds2D getPathIterator getPathIterator inside intersects intersects invalidate reset translate

Field Detail

lastHeight	back to summary
pack-priv int lastHeight Last value of height passed in.

lastWidth	back to summary
pack-priv int lastWidth Last value of width passed in.

percentIndexs	back to summary
pack-priv int[] percentIndexs

percentValues	back to summary
pack-priv float[] percentValues If any value is a percent there will be an entry here for the percent value. Use percentIndex to find out the index for it.

Constructor Detail

PolygonRegionContainment	back to summary
public PolygonRegionContainment(AttributeSet as)

Method Detail

contains back to summary

contains	back to summary
public boolean contains(int x, int y, int width, int height) Implements javax.swing.text.html.Map.RegionContainment.contains. Doc from javax.swing.text.html.Map.RegionContainment.contains. Returns true if the location `x`, `y` falls inside the region defined in the receiver. `width`, `height` is the size of the enclosing region.

public boolean contains(int x, int y, int width, int height)

Implements javax.swing.text.html.Map.RegionContainment.contains.

Doc from javax.swing.text.html.Map.RegionContainment.contains.

Returns true if the location x, y falls inside the region defined in the receiver. width, height is the size of the enclosing region.

javax.swing.text.html back to summary

pack-priv Class Map.RectangleRegionContainment

Class Inheritance

extends Object
implements RegionContainment

java.lang.Object
javax.swing.text.html.Map.RectangleRegionContainment

All Implemented Interfaces

javax.swing.text.html.Map.RegionContainment

Used to test for containment in a rectangular region.

Field Summary

Modifier and Type	Field and Description
pack-priv int	lastHeight Last value of height passed in.
pack-priv int	lastWidth Last value of width passed in.
pack-priv float[]	percents Will be non-null if one of the values is a percent, and any value that is non null indicates it is a percent (order is x, y, width, height).
pack-priv int	x0 Top left.
pack-priv int	x1 Bottom right.
pack-priv int	y0
pack-priv int	y1

Constructor Summary

Access	Constructor and Description
public	RectangleRegionContainment(AttributeSet as)

Method Summary

Modifier and Type	Method and Description
public boolean	contains(int x, int y, int width, int height) Implements javax.swing.text.html.Map.RegionContainment.contains. Returns true if the location `x`, `y` falls inside the region defined in the receiver.
public boolean	contains(int x, int y)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

lastHeight	back to summary
pack-priv int lastHeight Last value of height passed in.

lastWidth	back to summary
pack-priv int lastWidth Last value of width passed in.

percents	back to summary
pack-priv float[] percents Will be non-null if one of the values is a percent, and any value that is non null indicates it is a percent (order is x, y, width, height).

x0	back to summary
pack-priv int x0 Top left.

x1	back to summary
pack-priv int x1 Bottom right.

y0	back to summary
pack-priv int y0

y1	back to summary
pack-priv int y1

Constructor Detail

RectangleRegionContainment	back to summary
public RectangleRegionContainment(AttributeSet as)

Method Detail

contains back to summary

public boolean contains(int x, int y, int width, int height)

Implements javax.swing.text.html.Map.RegionContainment.contains.

Doc from javax.swing.text.html.Map.RegionContainment.contains.

Returns true if the location x, y falls inside the region defined in the receiver. width, height is the size of the enclosing region.

contains	back to summary
public boolean contains(int x, int y)

javax.swing.text.html back to summary

pack-priv Interface Map.RegionContainment

Known Direct Implementers: javax.swing.text.html.Map.RectangleRegionContainment, javax.swing.text.html.Map.PolygonRegionContainment, javax.swing.text.html.Map.CircleRegionContainment, javax.swing.text.html.Map.DefaultRegionContainment

Defines the interface used for to check if a point is inside a region.

Method Summary

Modifier and Type	Method and Description
public boolean	contains(int x, int y, int width, int height) Returns true if the location `x`, `y` falls inside the region defined in the receiver.

Method Detail

contains	back to summary
public boolean contains(int x, int y, int width, int height) Returns true if the location `x`, `y` falls inside the region defined in the receiver. `width`, `height` is the size of the enclosing region.