Crossfire JXClient, Trunk: com.realtime.crossfire.jxclient.gui.gauge.Orientation Interface Reference

Crossfire JXClient, Trunk

Inheritance diagram for com.realtime.crossfire.jxclient.gui.gauge.Orientation:

Inheritance graph

Collaboration diagram for com.realtime.crossfire.jxclient.gui.gauge.Orientation:

Collaboration graph

Public Member Functions
int	getH ()

int	getW ()

int	getX ()

int	getY ()

boolean	isLowImage ()

boolean	isNegativeImage ()

boolean	isValid ()

boolean	setExtends (int width, int height)

void	setHasNegativeImage (boolean hasNegativeImage)

boolean	setValues (int cur, int min, int max)

Detailed Description

Interface for orientation images.

Author: Andreas Kirschbaum

Definition at line 29 of file Orientation.java.

Member Function Documentation

◆ getH()

int com.realtime.crossfire.jxclient.gui.gauge.Orientation.getH ( )

Returns the height of the highlighted part of the image.

Returns: the height

Implemented in com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.

◆ getW()

int com.realtime.crossfire.jxclient.gui.gauge.Orientation.getW ( )

Returns the width of the highlighted part of the image.

Returns: the width

Implemented in com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.

◆ getX()

int com.realtime.crossfire.jxclient.gui.gauge.Orientation.getX ( )

Returns the x-coordinate of the highlighted part of the image.

Returns: the x-coordinate

Implemented in com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.

◆ getY()

int com.realtime.crossfire.jxclient.gui.gauge.Orientation.getY ( )

Returns the y-coordinate of the highlighted part of the image.

Returns: the y-coordinate

Implemented in com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.

◆ isLowImage()

boolean com.realtime.crossfire.jxclient.gui.gauge.Orientation.isLowImage ( )

Returns whether the low image should be shown.

Returns: whether the low image should be shown

Implemented in com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.

Referenced by com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientationTest.isLowImage().

Here is the caller graph for this function:

◆ isNegativeImage()

boolean com.realtime.crossfire.jxclient.gui.gauge.Orientation.isNegativeImage ( )

Returns whether the negative image should be shown.

Returns: whether the negative image should be shown

Implemented in com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.

◆ isValid()

boolean com.realtime.crossfire.jxclient.gui.gauge.Orientation.isValid ( )

Returns whether the gauge's values are valid.

Returns: whether the values are valid

Implemented in com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.

◆ setExtends()

boolean com.realtime.crossfire.jxclient.gui.gauge.Orientation.setExtends	(	int	width,
		int	height
	)

Sets the extends of the image.

Parameters

width	the width
height	the height

Returns: true if the size changed, false else

Implemented in com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.

Referenced by com.realtime.crossfire.jxclient.gui.gauge.OrientationTest.checkNegative(), com.realtime.crossfire.jxclient.gui.gauge.OrientationTest.checkPositive(), com.realtime.crossfire.jxclient.gui.gauge.GUIDupGauge.GUIDupGauge(), com.realtime.crossfire.jxclient.gui.gauge.GUIGauge.GUIGauge(), com.realtime.crossfire.jxclient.gui.gauge.GUIGauge.setBounds(), and com.realtime.crossfire.jxclient.gui.gauge.GUIDupGauge.setBounds().

Here is the caller graph for this function:

◆ setHasNegativeImage()

void com.realtime.crossfire.jxclient.gui.gauge.Orientation.setHasNegativeImage ( boolean hasNegativeImage )

Sets whether the gauge can display negative images. By default, negative images are not supported.

Parameters

hasNegativeImage whether the gauge can display negative images

Implemented in com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.

Referenced by com.realtime.crossfire.jxclient.gui.gauge.OrientationTest.checkNegative(), com.realtime.crossfire.jxclient.gui.gauge.OrientationTest.checkPositive(), and com.realtime.crossfire.jxclient.gui.gauge.GUIGauge.GUIGauge().

Here is the caller graph for this function:

◆ setValues()

boolean com.realtime.crossfire.jxclient.gui.gauge.Orientation.setValues	(	int	cur,
		int	min,
		int	max
	)

Sets the gauge's values.

Parameters

cur	the current value
min	the minimum value
max	the maximum value

Returns: whether the values have been updated

Implemented in com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientation.

Referenced by com.realtime.crossfire.jxclient.gui.gauge.OrientationTest.checkNegative(), com.realtime.crossfire.jxclient.gui.gauge.OrientationTest.checkPositive(), com.realtime.crossfire.jxclient.gui.gauge.GUIDupGauge.GUIDupGauge(), com.realtime.crossfire.jxclient.gui.gauge.GUIGauge.GUIGauge(), com.realtime.crossfire.jxclient.gui.gauge.AbstractOrientationTest.isLowImage(), com.realtime.crossfire.jxclient.gui.gauge.GUIGauge.setValues(), and com.realtime.crossfire.jxclient.gui.gauge.GUIDupGauge.setValues().

Here is the caller graph for this function:

The documentation for this interface was generated from the following file:

src/gui/src/main/java/com/realtime/crossfire/jxclient/gui/gauge/Orientation.java