ptolemy.kernel.util
Interface Moveable

All Known Implementing Classes:

Absent, AbsoluteValue, AbsoluteValue, AbstractActionsAttribute, AbstractCalInterpreter, AbstractPlaceableActor, AbstractSettableAttribute, AbstractTextAttribute, Accumulator, Accumulator, Accumulator, Action, ActorGraphTableau, ActorGraphTableau.Factory, ActorNameIcon, ActorRecursion, ActorScopeExtender, AdaptiveMedian, AddSubtract, AddSubtract, AnnotationEditorFactory, AnythingToDouble, ApplianceController, ApplyFilterOverArray, ApplyFunction, ApplyFunctionOverSequence, Argument, ArrayAppend, ArrayAppend, ArrayAverage, ArrayAverage, ArrayContains, ArrayElement, ArrayElement, ArrayElementAsMatrix, ArrayElementAsMatrix, ArrayExtract, ArrayExtract, ArrayLength, ArrayLength, ArrayLevelCrossing, ArrayLevelCrossing, ArrayMaximum, ArrayMaximum, ArrayMinimum, ArrayMinimum, ArrayPeakSearch, ArrayPeakSearch, ArrayPeakSearch, ArrayPlotter, ArrayPlotterXY, ArrayRemoveElement, ArraySort, ArraySum, ArrayToElements, ArrayToElements, ArrayToSequence, ArrayToSequence, ArrowKeySensor, AtomicActor, AtomicActorMatcher, AtomicWirelessChannel, Attribute, AttributeExpressionAttribute, AttributeValueAttribute, AttributeValueIcon, AudioCapture, AudioPlayer, AudioPlayer, AudioPlayer, AudioReadBuffer, AudioReader, AudioReader, AudioSDLActor, AudioWriteBuffer, AudioWriter, AudioWriter, Autocorrelation, Autocorrelation, Average, Average, Average, BackDropQueue, Backtrack, BackwardEulerSolver, BarGraph, Barrier, Barrier, BaseSDFScheduler, BaseUnit, Bernoulli, Bernoulli, BinarySwitch, BitsToInt, BitsToInt, BooleanMultiplexor, BooleanMultiplexor, BooleanSelect, BooleanSelect, BooleanSelect, BooleanSwitch, BooleanSwitch, BooleanSwitch, BooleanToAnything, BooleanToAnything, Box2D, Box3D, BoxedValueIcon, BoxedValuesIcon, BrowserEffigy, BrowserEffigy.Factory, BrowserTableau, BrowserTableau.Factory, Buffer, Buffer, BusAssembler, BusDisassembler, ButtonTime, CachedSDFScheduler, CalInterpreter, CartesianToComplex, CartesianToComplex, CartesianToPolar, CartesianToPolar, Case, Case, Case, CaseDirector, CaseGraphTableau, CaseGraphTableau.Factory, CCodeGenerator, CCodeGeneratorHelper, ChannelPort, CheckBoxStyle, ChoiceStyle, Chop, Chop, Chop, CIActor, CIDirector, CipherActor, CircularSweep3D, ClassWrapper, ClipPlayer, Clock, CodegenActor, CodegenActor, CodeGenerator, CodeGeneratorGUIFactory, CodeGeneratorHelper, CollisionDetector, ColorAttribute, ColorFinder, ColtBeta, ColtBinomial, ColtBinomialSelector, ColtBreitWigner, ColtChiSquare, ColtExponential, ColtExponentialPower, ColtGamma, ColtHyperGeometric, ColtLogarithmic, ColtNegativeBinomial, ColtNormal, ColtPoisson, ColtPoissonSlow, ColtRandomSource, ColtStudentT, ColtVonMises, ColtZeta, CommandListener, CommitActionsAttribute, Commutator, Commutator, Commutator, Comparator, Comparator, CompiledCompositeActor, CompiledCompositeActor, ComplexAddSubtract, ComplexToCartesian, ComplexToCartesian, ComplexToPolar, ComponentEntity, ComponentPort, ComponentRelation, CompositeActor, CompositeActorMatcher, CompositeEntity, CompositeProcessDirector, ComputeHistogram, ComputeHistogram, Cone3D, ConfigurableAttribute, Configuration, ConfigurationEffigy, Const, Const, Constraint, ContextMenuFactoryCreator, ContinuousClock, ContinuousDirector, ContinuousIntegrator, ContinuousScheduler, ContinuousTransferFunction, Converter, ConvolutionalCoder, CopyCatIcon, Counter, Counter, Counter, CountTrues, CountTrues, Course, CryptographyActor, CSPActor, CSPBuffer, CSPDirector, CSPMultiSink, CSPMultiSource, CSPSieve, CSPSink, CSPSource, CTBaseIntegrator, CTCase, CTCaseDirector, CTCompositeActor, CTCompositeActor, CTDirector, CTEmbeddedDirector, CTMixedSignalDirector, CTMultiSolverDirector, CTPeriodicSampler, CTRateLimiter, CTRefinement, CTScheduler, CTTriggeredSampler, Current, CurrentTime, CurrentTime, Cylinder3D, DatagramReader, DatagramWriter, DB, DB, DDEActor, DDEDirector, DDEIOPort, DDESink, DDFBooleanSelect, DDFDirector, DDFOrderedMerge, DDFSelect, DDFSingleTokenCommutator, DEActor, DebugController, DebugListenerTableau, DEDirector, Default, DefaultDirectoryAttribute, DefaultModelAttribute, DelayChannel, DelayLine, DelayLine, DelayStart, DependencyDeclaration, DependencyHighlighter, DependencyHighlighter, DerivativeResolver, DeScrambler, DEThreadActor, DETransformer, DialogTableau, Differential, Differential, Differential, DifferentialSystem, DifferentialSystem, Director, DirectoryListing, Discard, Discard, DiscreteClock, DiscreteClock, DiscreteRandomSource, DiscreteRandomSource, Display, Display, DistributedDirector, DistributedLineWriter, DistributedSDFDirector, DistributedSDFScheduler, DistributedTypedCompositeActor, DistributedTypedIORelation, Distributor, Distributor, Distributor, DocAttribute, DocBuilder, DocBuilderEffigy, DocBuilderEffigy.Factory, DocBuilderTableau, DocBuilderTableau.Factory, DocEffigy, DocEffigy.Factory, DocTableau, DocTableau.Factory, Documentation, DocumentationAttribute, DocViewerFactory, DotProduct, DotProduct, DoubleFork, DoubleMatrixToJAI, DoubleRangeParameter, DoubleReader, DoubleReader, DoubleToFix, DoubleToMatrix, DownSample, DownSample, DTDirector, DynamicEditorIcon, EditableChoiceStyle, EditIconTableau, EditIconTableau.Factory, EditorFactory, EditorIcon, EditorPaneFactory, Effigy, EffigyFactory, ElementsToArray, ElementsToArray, Ellipse2D, EllipseAttribute, EmbeddedCActor, EmbeddedCActor, EmbeddedCActor.EmbeddedActor, EmbeddedCActor.EmbeddedActor, EnabledComposite, Entity, EntityLibrary, Equals, Equals, ErasureChannel, EventButton, EventFilter, EventSource, EventSource, Exec, Exit, Exit, ExpertParameter, ExplicitRK23Solver, ExplicitRK45Solver, Expression, Expression, Expression, ExpressionReader, ExpressionShellEffigy, ExpressionShellEffigy.ShellFactory, ExpressionShellTableau, ExpressionShellTableau.Factory, ExpressionToToken, ExpressionWriter, ExpressionWriter, ExternalTextEffigy, ExternalTextTableau, FeedBackDelay, FFT, FFT, FileAttribute, FileChooserStyle, FileEditorTableauFactory, FileOrURLEditorFactory, FileParameter, FilePortParameter, FileReader, FileReader, FileWriter, FilledShapeAttribute, FIR, FIR, FirstOrderHold, FixedPointDirector, FixedPointScheduler, FixedStepSolver, FixToDouble, FixToFix, ForwardEulerSolver, FrontDropQueue, FSMActor, FSMActor, FSMDirector, FSMGraphTableau, FSMGraphTableau.Factory, FSMMatcher, FunctionDependency, FunctionDependencyOfAtomicActor, FunctionDependencyOfCompositeActor, FunctionDependencyOfEnabledCompositeActor, FunctionDependencyOfFSMActor, FunctionDependencyOfModalModel, Gaussian, Gaussian, Gaussian, GeneratorAttribute, GeneratorTableau, GeneratorTableau.Factory, GeneratorTableauAttribute, GenericJNIActor, GetProperties, GiottoCodeGenerator, GiottoCodeGenerator.GiottoEditorFactory, GiottoDirector, GiottoScheduler, GRActor, GRActor2D, GRActor3D, GradientAdaptiveLattice, GradientAdaptiveLattice, GradientAdaptiveLattice, GraphicalLocator, GRDirector, GRScheduler, GRShadedShape, GRShape2D, GRTransform, GRTransform2D, GTIngredientsAttribute, GTIngredientsEditor.Factory, GTParameter, GTTableau, GTTableau.Factory, HadamardCode, HammingCoder, HammingCoder, HammingDecoder, HammingDecoder, HDFDirector, HDFFSMDirector, HierarchicalStateControllerFactory, HierarchyFlatteningAttribute, HighlightEntities, HighlightEntities.HighlightIcons, HistogramPlotter, HSFSMDirector, HSIFEffigyFactory, HTMLEffigy, HTMLEffigyFactory, HTMLViewerTableau, HTMLViewerTableau.Factory, HTVQEncode, HuffmanBasic, HuffmanCoder, HuffmanDecoder, HybridModalDirector, IDAttribute, IFFT, IFFT, IIR, IIR, Image2D, ImageAttribute, ImageContrast, ImageDisplay, ImageDisplay, ImageIcon, ImagePartition, ImageReader, ImageRotate, ImageSequence, ImageTableau, ImageTableau.Factory, ImageToJAI, ImageToJMF, ImageToString, ImageUnpartition, ImportAttribute, Inhibit, InsideEntityEditorPaneFactory, InstantaneousDialogGenerator, InstantiableNamedObj, IntArrayToString, Integrator, Integrator, InteractiveShell, InteractiveShell.ShellTableau, InterfaceAutomaton, InterfaceAutomatonGraphTableau, InterfaceAutomatonGraphTableau.Factory, InterfaceAutomatonTransition, Interpolator, Interpolator, IntRangeParameter, IntToBits, IntToBits, InUnitsOf, IOPort, IORelation, IsPresent, IsPresent, IterateOverArray, IterateOverArray.IterateComposite, IterateOverArray.IteratePort, JAIAffineTransform, JAIBandCombine, JAIBandSelect, JAIBMPWriter, JAIBorder, JAIBoxFilter, JAIConstant, JAIConvolve, JAICrop, JAIDataConvert, JAIDCT, JAIDFT, JAIEdgeDetection, JAIIDCT, JAIIDFT, JAIImageReader, JAIInvert, JAIJPEGWriter, JAILog, JAIMagnitude, JAIMedianFilter, JAIPeriodicShift, JAIPhase, JAIPNGWriter, JAIPNMWriter, JAIPolarToComplex, JAIRotate, JAIScale, JAITIFFWriter, JAIToDoubleMatrix, JAITranslate, JAITranspose, JAIWriter, JNIActorEditorFactory, JNICodeGenerator, JNICodeGeneratorGUIFactory, Joystick, JVMTableau, JVMTableau.Factory, KeplerDocumentationAttribute, KeyInput3D, KeyReader, KeyStoreActor, KeyWriter, LampController, Lattice, Lattice, LEDMatrix, LEDMatrix, LempelZivCoder, LempelZivDecoder, LevelCrossingDetector, LevelCrossingDetector, LevelListener, LevelSkippingTableauFactory, LevinsonDurbin, LibraryAttribute, LifeCycleManager, LimitedFiringSource, LimitedRangeChannel, Limiter, Limiter, Line2D, LinearDifferenceEquationSystem, LinearDifferenceEquationSystem, LinearStateSpace, LineAttribute, LineCoder, LineReader, LineReader, LineStyle, LineWriter, LineWriter, LinkVisualizer, Listener, LiveSoundActor, LMSAdaptive, LMSAdaptive, Location, LocationAttribute, LocationParameter, Locator, LogicalNot, LogicalNot, LogicFunction, LogicFunction, LongToDouble, LookupTable, LookupTable, Manager, MapFileStorage, MapWorker, MatchResultTableau, MatchResultTableau.Factory, MathFunction, MatrixJoin, MatrixSplit, MatrixToDouble, MatrixTokenTableau, MatrixTokenTableau.Factory, MatrixToSequence, MatrixViewer, Maximum, Maximum, MaxIndex, Merge, Merge, MicaCompositeActor, MicaLeds, Minimum, Minimum, MirrorComposite, MirrorComposite.MirrorCompositeContents, MirrorPort, MobileFunction, MobileModel, ModalController, ModalController, ModalDirector, ModalModel, ModalModel, ModalPort, ModalTableauFactory, ModelDirectory, ModelDisplay, ModelGenerator, ModelReference, ModelView, MoMLAttribute, MonitorImage, MonitorValue, MonitorValue, MouseInput3D, MovableViewScreen3D, MovieReader, MovieViewScreen2D, MovieViewScreen3D, MovieWriter, MovingAverage, MovingAverage, MultiCompositeActor, MultiCompositeActor, MultiCompositePort, MultiInstanceComposite, MultiInstanceComposite, Multiplexor, Multiplexor, MultiplyDivide, MultiplyDivide, MultirateFSMDirector, NamedObj, NamedObjVariable, NameIcon, NameParameter, NavigableActorGraphTableau, NavigableActorGraphTableau.Factory, NavigableEffigy, NavigableEffigy.Factory, NavigableEffigy.FactoryWithoutNew, NCComponentBase, NCCompositeActor, NCCompositeActorTableauFactory, NodeControllerFactory, NodeRandomizer, NondeterministicMerge, NonInterruptibleTimer, NonStrictDelay, NonStrictDisplay, NonStrictFSMDirector, NonStrictLogicFunction, NonStrictTest, NonStrictThreeBitAdder, NotEditableLineStyle, ODESolver, Or, OrderedMerge, OrderedMerge, OutputActionsAttribute, Parameter, ParameterAttribute, ParameterEditorStyle, ParameterPort, ParameterSet, ParserAttribute, PasswordAttribute, Pattern, PatternObjectAttribute, PetriNetActor, PetriNetDirector, PhaseUnwrap, PhaseUnwrap, Place, PlaySound, PlotEffigy, PlotEffigy.Factory, PlotTableau, PlotTableau.Factory, Plotter, PlotterBase, PlotterBase, PlotterBase.PlotWindowTableau, PNDirector, PoissonClock, PoissonClock, PolarToCartesian, PolarToCartesian, PolarToComplex, PolyCylinder3D, Port, PortMatcher, PortParameter, PowerLossChannel, Pre, Previous, PrivateKeyReader, ProcessDirector, PSDFDirector, PSDFScheduler, PSNR, PtalonActor, PtalonExpressionParameter, PtalonParameter, PtinyOSCompositeActor, PtinyOSDirector, PtinyOSNodeParameter, PtolemyEffigy, PtolemyEffigy.Factory, PtolemyEffigy.FactoryWithoutNew, PtolemyPreferences, PtolemyTableauFactory, PublicKeyReader, Publisher, Publisher, PublisherNonStrictTest, PublisherTest, PublisherTest, Pulse, Pulse, Pulse, PythonScript, Quantizer, Quantizer, Queue, Queue, RaisedCosine, RaisedCosine, Ramp, Ramp, Ramp, RandomSource, RandomSource, RandomSource, Reader, RealTimeComposite, RealTimePlotter, Receiver, RecordAssembler, RecordDisassembler, Recorder, Recorder, RecordUpdater, Rectangle2D, RectangleAttribute, RectangularFigure2D, RecursiveLattice, RecursiveLattice, RecursiveLattice, ReduceWorker, Refinement, Refinement, Refinement, Refinement, RefinementPort, RefinementPort, Register, Relation, RelationCollapsingAttribute, RelationHidingAttribute, Remainder, Remainder, RemoveNilTokens, RendezvousDirector, Repeat, Repeat, Replacement, ReplacementObjectAttribute, RequireVersion, ResizableAttributeControllerFactory, ResizablePolygonAttribute, ResourcePool, ResourcePool, Rician, Rician, Rotate2D, Rotate3D, Round, Round, RunCompositeActor, RunTableau, RunTableau.Factory, RunTableau.TopFactory, SaltAndPepper, SampleDelay, SampleDelay, Sampler, Scale, Scale, Scale2D, Scale3D, SchedulePlotter, SchedulePlotter.SchedulePlotterEditorFactory, Scheduler, ScopeExtendingAttribute, Scrambler, SDFConverter, SDFDirector, SDFIOPort, SDFScheduler, SDFTransformer, SecretKey, SecretKeyReader, Select, Select, Sender, Sequence, Sequence, Sequence, SequencePlotter, SequencePlotter, Sequencer, Sequencer, SequenceScope, SequenceScope, SequenceSource, SequenceToArray, SequenceToArray, SequenceToMatrix, SequentialClock, SequentialClock, SerialComm, Server, SetProperties, SetVariable, SetVariable, ShapeAttribute, ShapeIcon, SharedParameter, SignatureActor, SignatureSigner, SignatureVerifier, SingleEvent, SingleTokenCommutator, SingleTokenDistributor, SingletonAttribute, SingletonConfigurableAttribute, SingletonParameter, SingleWindowConfiguration, SingleWindowHTMLViewerTableau, SingleWindowHTMLViewerTableau.Factory, Sink, Sink, SizeAttribute, SketchedSource, Sleep, Sleep, Slicer, SliderSource, SliderSource, SoundActor, SoundPlayer, Source, Sphere3D, SplitReader, SRDirector, SROptimizedScheduler, SRRandomizedScheduler, Starver, State, StateIcon, StateMatcher, StateMatcherIcon, StaticSchedulingCodeGenerator, StaticSchedulingDirector, Stop, Stop, StreamLoader, StringAttribute, StringCompare, StringCompare, StringConst, StringConst, StringFunction, StringFunction, StringIndexOf, StringIndexOf, StringLength, StringLength, StringMatches, StringMatches, StringParameter, StringReplace, StringSubstring, StringSubstring, StringToIntArray, StringToIntArray, StringToKeyValue, StringToUnsignedByteArray, StringToXML, SubMatrix, Subscriber, Subscriber, SubscriptionAggregator, SubscriptionAggregator, SurgeVisualizer, SVGIcon, Switch, Switch, SymmetricDecryption, SymmetricEncryption, Synchronizer, Synchronizer, Tableau, TableauFactory, TemporaryVariable, TerrainProperty, Test, Test, TestExceptionHandler, TextAttribute, TextEditorConfigureFactory, TextEditorTableau, TextEditorTableau.Factory, TextEditorTableauFactory, TextEffigy, TextEffigy.Factory, TextIcon, TextString3D, TextStyle, ThresholdMonitor, ThrowException, ThrowException, ThrowModelError, ThrowModelError, TimedDelay, TimedPlotter, TimedPNDirector, TimedScope, TimedSource, TimeGap, Timer, TMCompositeFacade, TMDirector, TokenEffigy, TokenEffigy.Factory, TokenTableau, TokenTableau.Factory, TokenToExpression, TokenToExpression, Torus3D, TransformationAttribute, TransformationRule, TransformationRule.TransformationDirector, Transformer, TransientSingletonConfigurableAttribute, Transition, TransitionRefinement, TransitionRefinement, TransitionRefinementPort, Translate2D, Translate3D, TransmitPropertyTransformer, TrapezoidalRuleSolver, TreeTableau, TreeTableau.Factory, TrellisDecoder, Triangular, Triangulator, TrigFunction, TrigFunction, TriggeredClock, TriggeredContinuousClock, TypeAttribute, TypedAtomicActor, TypedCompositeActor, TypedCompositeActor, TypedIOPort, TypedIORelation, TypeOpaqueCompositeActor, TypeOpaqueCompositeActorTableauFactory, TypeTest, UnaryMathFunction, UnaryMathFunction, Undefined, UndoStackAttribute, Uniform, Uniform, UnionDisassembler, UnionMerge, UnitAttribute, UnitCategory, UnitSystem, UnsignedByteArrayToString, UpdatedValueIcon, UpSample, UpSample, URIAttribute, URLDirectoryReader, URLReader, URLToImage, ValueIcon, Variable, VariableClock, VariableDelay, VariableFIR, VariableFIR, VariableLattice, VariableLattice, VariableRecursiveLattice, VariableRecursiveLattice, VariableSleep, VectorAssembler, VectorAssembler, VectorDisassembler, VectorDisassembler, VersionAttribute, Vertex, VideoCamera, VideoPlayer, ViewScreen2D, ViewScreen3D, VisibleAttribute, VisibleParameterEditorFactory, VisualModelReference, VisualModelReference.LookInside, ViterbiDecoder, VQDecode, WaitingTime, WallClockTime, WallClockTime, WelcomeWindowTableau, When, WindowPropertiesAttribute, Wire, Wire, WiredToWireless, WirelessComposite, WirelessDirector, WirelessIOPort, WirelessToWired, Writer, X10Interface, XMLIcon, XMLInclusion, XSLTransformer, XYPlotter, XYPlotter, XYScope, XYScope, ZeroCrossingDetector, ZeroCrossingDetector, ZeroOrderHold, ZeroOrderHold

public interface Moveable

This is an interface for objects that can be moved in a list of objects in a container.

Since:

Ptolemy II 4.1

Version:

$Id: Moveable.java,v 1.8 2005/07/08 19:59:18 cxh Exp $

Author:

Edward A. Lee

Accepted Rating:

Green (hyzheng)

Proposed Rating:

Green (eal)

Method Summary

int	moveDown() Move this object down by one in the list of objects in its container.
int	moveToFirst() Move this object to the first position in the list of objects in its container.
int	moveToIndex(int index) Move this object to the specified position in the list of objects in its container, where 0 is the first position.
int	moveToLast() Move this object to the last position in the list of objects in its container.
int	moveUp() Move this object up by one in the list of objects in its container.

Method Detail

moveDown

int moveDown()
             throws IllegalActionException

Move this object down by one in the list of objects in its container. If the object is already last on the list, then it is not moved.

Returns:

The index of this object prior to moving it, or -1 if it is not moved.

Throws:

IllegalActionException - If this object has no container.

moveToFirst

int moveToFirst()
                throws IllegalActionException

Move this object to the first position in the list of objects in its container. If the object is already first on the list, then it is not moved.

Returns:

The index of this object prior to moving it, or -1 if it is not moved.

Throws:

IllegalActionException - If this object has no container.

moveToIndex

int moveToIndex(int index)
                throws IllegalActionException

Move this object to the specified position in the list of objects in its container, where 0 is the first position. If the object is already at the specified position, then it is not moved.

Parameters:

index - The position to which to move the object.

Returns:

The index of this object prior to moving it, or -1 if it is not moved.

Throws:

IllegalActionException - If this object has no container or if the index is out of range.

moveToLast

int moveToLast()
               throws IllegalActionException

Move this object to the last position in the list of objects in its container. If the object is already last on the list, then it is not moved.

Returns:

The index of this object prior to moving it, or -1 if it was not moved.

Throws:

IllegalActionException - If this object has no container.

moveUp

int moveUp()
           throws IllegalActionException

Move this object up by one in the list of objects in its container. If the object is already first on the list, then it is not moved.

Returns:

The index of this object prior to moving it, or -1 if it was not moved.

Throws:

IllegalActionException - If this object has no container.