com.tensegrity.composite
Interface CompositeViewMeasurementObject

All Superinterfaces:

Attributable, AttributableOnSet

All Known Subinterfaces:

CompositeViewGrid, CompositeViewRuler

public interface CompositeViewMeasurementObject

extends AttributableOnSet

Specifies the common methods of the CompositeViewRuler and the CompositeViewGrid.

Version:

$Id: CompositeViewMeasurementObject.java,v 1.4 2004/09/06 09:00:05 AndreasEbbert Exp $

Author:

AndreasEbbert

See Also:

CompositeViewGrid, CompositeViewRuler

Field Summary

static java.lang.String	METRIC_UNIT_DESC Name of the unit Attribute
static java.lang.String	VISIBLE_DESC Constant holding a name for the visibility attribute.

Fields inherited from interface com.tensegrity.generic.attribute.AttributableOnSet

TREE_SUBSET_POSTFIX

Method Summary

CoordinateSystemMetric	getMetric() Returns the used CoordinateSystemMetric of this ruler.
int	getUnit() Returns the metric unit used by this measurement object.
boolean	isVisible() Returns the visibility of this ruler.
void	setMetric(CoordinateSystemMetric metric) Sets the metric used by this ruler to the given CoordinateSystemMetric.
void	setUnit(int unit) Sets the unit to be used for the concrete measurement object.
void	setVisible(boolean vis) Sets the visibility of this ruler.

Methods inherited from interface com.tensegrity.generic.attribute.AttributableOnSet

addAttributableOnSetListener, areAttributableEventsEnabled, disableAttributableEvents, enableAttributableEvents, getAttributes, getAttributesTree, removeAttributableOnSetListener, setAttributes, setAttributesTree

Methods inherited from interface com.tensegrity.generic.attribute.Attributable

getAttribute, getAttributeType, getAttributeValue, setAttribute, setAttributeValue

Field Detail

METRIC_UNIT_DESC

public static final java.lang.String METRIC_UNIT_DESC

Name of the unit Attribute

See Also:

Constant Field Values

VISIBLE_DESC

public static final java.lang.String VISIBLE_DESC

Constant holding a name for the visibility attribute.

See Also:

Constant Field Values

Method Detail

isVisible

public boolean isVisible()

Returns the visibility of this ruler.

Returns:

the visibility of this ruler.

setVisible

public void setVisible(boolean vis)

Sets the visibility of this ruler.

Parameters:

vis - the visibility.

getUnit

public int getUnit()

Returns the metric unit used by this measurement object. Have a look at the unit constants specified in class MetricConstants.

Returns:

the metric unit used by this measurement object.

setUnit

public void setUnit(int unit)

Sets the unit to be used for the concrete measurement object. Valid values for the given parameter are specified in class MetricConstants, e.g. MetricConstants.CENTIMETER is a valid value.

Parameters:

unit - the unit to use. The default is MetricConstants.CENTIMETER.

setMetric

public void setMetric(CoordinateSystemMetric metric)

Sets the metric used by this ruler to the given CoordinateSystemMetric.

Parameters:

metric - the metric to use.

getMetric

public CoordinateSystemMetric getMetric()

Returns the used CoordinateSystemMetric of this ruler.

Returns:

the used CoordinateSystemMetric of this ruler.