Package hec.gfx2d

Class GfxLabelItem

java.lang.Object

hec.gfx2d.GfxTextObject

hec.gfx2d.GfxLabelItem

public class GfxLabelItem
extends GfxTextObject

GfxLabelItem class used by MapCanvas to prevent cluttering of text on screen

Field Summary

Fields

Modifier and Type	Field	Description
static final int	EAST	east position
static final int	NORTH	north position
static final int	NORTHEAST	northeast position
static final int	NORTHWEST	northwest position
static final String[]	POSITION_STRINGS	the positions as strings
static final int	SOUTH	south position
static final int	SOUTHEAST	southeast position
static final int	SOUTHWEST	southwest position
static final int	WEST	west position

Fields inherited from class hec.gfx2d.GfxTextObject

_bgcolor, _bounds, _fgcolor, _font, _priority, _strwidth, _text

Constructor Summary

Constructors

Constructor	Description
GfxLabelItem(String txt, int x, int y, float priority, Font font, Color fg, Color bg, Graphics g)	Create a new GfxLabelItem object
GfxLabelItem(String txt, int x, int y, int pos, int offset, float priority, Font font, Color fg, Color bg, boolean drawBorder, Graphics g)	Create a new GfxLabelItem object
GfxLabelItem(String txt, int x, int y, int pos, int size, float priority, Font font, Color fg, Color bg, Graphics g)	Create a new GfxLabelItem object
GfxLabelItem(String txt, int x, int y, int pos, int iconWidth, int iconHeight, float priority, Font font, Color fg, Color bg, boolean drawBorder, Graphics g)	Create a new GfxLabelItem object

Method Summary

Modifier and Type	Method	Description
void	draw(Graphics g)	Method Description
LocalRect	getBounds()	Gets the Bounds attribute of the GfxLabelItem object
LocalRect	getLocalRect()	Gets the LocalRect attribute of the GfxLabelItem object
LocalRect	getLocalRect(LocalRect rc)	Gets the LocalRect attribute of the GfxLabelItem object
String	getText()	Gets the Text attribute of the GfxLabelItem object
boolean	intersects(GfxTextObject obj)	Method Description

Methods inherited from class java.lang.Object

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

Field Details

EAST

public static final int EAST

east position

See Also:

• Constant Field Values

NORTHEAST

public static final int NORTHEAST

northeast position

See Also:

• Constant Field Values

NORTH

public static final int NORTH

north position

See Also:

• Constant Field Values

NORTHWEST

public static final int NORTHWEST

northwest position

See Also:

• Constant Field Values

WEST

public static final int WEST

west position

See Also:

• Constant Field Values

SOUTHWEST

public static final int SOUTHWEST

southwest position

See Also:

• Constant Field Values

SOUTH

public static final int SOUTH

south position

See Also:

• Constant Field Values

SOUTHEAST

public static final int SOUTHEAST

southeast position

See Also:

• Constant Field Values

POSITION_STRINGS

public static final String[] POSITION_STRINGS

the positions as strings

Constructor Details

GfxLabelItem

public GfxLabelItem(String txt,
 int x,
 int y,
 int pos,
 int iconWidth,
 int iconHeight,
 float priority,
 Font font,
 Color fg,
 Color bg,
 boolean drawBorder,
 Graphics g)

Create a new GfxLabelItem object

Parameters:

txt - the text to display

x - the x position

y - the y position

pos - the position NORTH, SOURTH etc

iconWidth - the width of the icon

iconHeight - the height of the icon

priority - the priority. -1 always draw. otherwise higher priority takes precidence of lower when labels overlap

font - the font to use

fg - the foreground color

bg - the background color

drawBorder - whether to draw a border or not

g - the graphics context to draw in

GfxLabelItem

public GfxLabelItem(String txt,
 int x,
 int y,
 int pos,
 int size,
 float priority,
 Font font,
 Color fg,
 Color bg,
 Graphics g)

Create a new GfxLabelItem object

Parameters:

txt - the text to display

x - the x position

y - the y position

pos - the position NORTH, SOURTH etc

size - the icon size

priority - the priority. -1 always draw. otherwise higher priority takes precidence of lower when labels overlap * @param font the font to use

fg - the foreground color

bg - the background color

g - the graphics context to draw in

GfxLabelItem

public GfxLabelItem(String txt,
 int x,
 int y,
 float priority,
 Font font,
 Color fg,
 Color bg,
 Graphics g)

Create a new GfxLabelItem object

Parameters:

txt - the text to display

x - the x position

y - the y position

priority - the priority. -1 always draw. otherwise higher priority takes precidence of lower when labels overlap

font - the font to use

fg - the foreground color

bg - the background color

g - the graphics context to draw in

GfxLabelItem

public GfxLabelItem(String txt,
 int x,
 int y,
 int pos,
 int offset,
 float priority,
 Font font,
 Color fg,
 Color bg,
 boolean drawBorder,
 Graphics g)

Create a new GfxLabelItem object

Parameters:

txt - the text to display

x - the x position

y - the y position

pos - the position NORTH, SOURTH etc

offset -

priority - the priority. -1 always draw. otherwise higher priority takes precidence of lower when labels overlap

font - the font to use

fg - the foreground color

bg - the background color

drawBorder - whether to draw a border or not

g - the graphics context to draw in

Method Details

intersects

public boolean intersects(GfxTextObject obj)

Method Description

Overrides:

intersects in class GfxTextObject

Parameters:

obj - Description

Returns:

Description

getBounds

public LocalRect getBounds()

Gets the Bounds attribute of the GfxLabelItem object

Specified by:

getBounds in class GfxTextObject

Returns:

The Bounds value

getLocalRect

public LocalRect getLocalRect()

Gets the LocalRect attribute of the GfxLabelItem object

Returns:

The LocalRect value

getLocalRect

public LocalRect getLocalRect(LocalRect rc)

Gets the LocalRect attribute of the GfxLabelItem object

Parameters:

rc - Description

Returns:

The LocalRect value

draw

public void draw(Graphics g)

Method Description

Specified by:

draw in class GfxTextObject

Parameters:

g - Description

getText

public String getText()

Gets the Text attribute of the GfxLabelItem object

Returns:

The Text value