Locatable

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES All Classes

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

ptolemy.kernel.util
Interface Locatable

All Superinterfaces:: Nameable, Settable

All Known Implementing Classes:: Location, LocationParameter

public interface Locatable
extends Settable

An interface for objects storing a location.

This interface is generally implemented by attributes of objects in a model and is used by the Vergil user interface to store the location of objects in the visual editor.

Since:: Ptolemy II 2.1
Version:: $Id: Locatable.java,v 1.15 2005年07月08日 19:59:17 cxh Exp $
Author:: Edward A. Lee
See Also:: Location
Accepted Rating:: Green (cxh)
Proposed Rating:: Green (cxh)

Nested Class Summary

Nested classes inherited from class ptolemy.kernel.util.Settable

Settable.Visibility

Field Summary

Fields inherited from interface ptolemy.kernel.util.Settable

EXPERT, FULL, NONE, NOT_EDITABLE

Method Summary
`double[]`	`getLocation()` Get the location in some cartesian coordinate system.
`void`	`setLocation(double[] location)` Set the location in some cartesian coordinate system, and notify the container and any value listeners of the new location.

Methods inherited from interface ptolemy.kernel.util.Settable

addValueListener, getDefaultExpression, getDisplayName, getExpression, getValueAsString, getVisibility, removeValueListener, setExpression, setVisibility, validate

Methods inherited from interface ptolemy.kernel.util.Nameable

description, getContainer, getFullName, getName, getName, setName

Method Detail

getLocation

public double[] getLocation()

Get the location in some cartesian coordinate system.

Returns:: The location.
See Also:: setLocation(double [])

setLocation

public void setLocation(double[] location)
 throws IllegalActionException

Set the location in some cartesian coordinate system, and notify the container and any value listeners of the new location.

Parameters:: location - The location.
Throws:: IllegalActionException - If the location is rejected.
See Also:: getLocation()