org.fife.rtext.plugins.macros
Class Macro

java.lang.Object
  org.fife.rtext.plugins.macros.Macro

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Comparable<Macro>

public class Macro
extends java.lang.Object
implements java.lang.Comparable<Macro>, java.lang.Cloneable

A macro; that is, a script to run in the RText JVM.

Version:

1.0

Author:

Robert Futrell

Constructor Summary

Macro()
Constructor used to support serialization.

Method Summary

java.lang.Object	clone() Returns a clone of this macro.
int	compareTo(Macro o) Compares this macro to another by name, lexicographically.
boolean	equals(java.lang.Object o) Returns whether this macro and another have the same name.
java.lang.String	getAccelerator()
java.lang.String	getDesc()
java.lang.String	getFile() Returns the full path to the file for this macro.
java.lang.String	getName()
int	hashCode()
void	setAccelerator(java.lang.String accelerator)
void	setDesc(java.lang.String desc)
void	setFile(java.lang.String file) Sets the full path to the file for this macro.
void	setName(java.lang.String name)
java.lang.String	toString() Overridden to return the name of this macro.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Macro

public Macro()

Constructor used to support serialization.

Method Detail

clone

public java.lang.Object clone()

Returns a clone of this macro.

Overrides:

clone in class java.lang.Object

Returns:

A clone of this macro.

compareTo

public int compareTo(Macro o)

Compares this macro to another by name, lexicographically.

Specified by:

compareTo in interface java.lang.Comparable<Macro>

Parameters:

o - The other macro.

Returns:

The sort order of this macro, compared to another.

equals

public boolean equals(java.lang.Object o)

Returns whether this macro and another have the same name.

Overrides:

equals in class java.lang.Object

Returns:

Whether this macro and another have the same name.

getAccelerator

public java.lang.String getAccelerator()

getDesc

public java.lang.String getDesc()

getFile

public java.lang.String getFile()

Returns the full path to the file for this macro.

Returns:

The full path to the file.

See Also:

setFile(String)

getName

public java.lang.String getName()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

setAccelerator

public void setAccelerator(java.lang.String accelerator)

setDesc

public void setDesc(java.lang.String desc)

setFile

public void setFile(java.lang.String file)

Sets the full path to the file for this macro.

Parameters:

file - The full path to the file.

See Also:

getFile()

setName

public void setName(java.lang.String name)

toString

public java.lang.String toString()

Overridden to return the name of this macro. Used by the Macro options panel.

Overrides:

toString in class java.lang.Object

Returns:

The name of this macro.