Package cs2

Class Button

java.lang.Object

cs2.Widget

cs2.Button

All Implemented Interfaces:

ClickAction

public class Button
extends Widget

Button class encapsulates a JButton and allows the student to create a button, install it on a Window, change the title of the button, and perform actions when the button is clicked. There are two ways to perform an action. 1) onClick(object) - this will call a method named "clicked" + title on "object"; where title is the title of the button. 2) onClick(object, name) - this will call a method named "name" on "object".

Author:

mapq, maellis, loran

Constructor Summary

Constructors

Constructor	Description
Button()	Constructor, by default has "Untitled" as title.
Button(java.lang.String title)	Constructor for the button with "title".

Method Summary

Modifier and Type	Method	Description
void	disable()	Disables this button.
void	enable()	Enables this button.
java.lang.String	getTitle()	Returns the title for the button.
void	onClick(Command scl)	Same as @see CS2114.Button.onClick(Object, String) except uses a listener object of type Command.
void	onClick(java.lang.Object object)	Sets up the handler for what to do when this button is clicked.
void	onClick(java.lang.Object object, java.lang.String methodName)	Specifies the method to call in the parameter.
void	remove()
void	setTitle(java.lang.String title)	Sets the title for the button.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from class cs2.Widget

collidesWith, contains, getBackgroundColor, getBounds, getForegroundColor, getWindow, getX, getY, repaint, setBackgroundColor, setForegroundColor, setX, setY

Constructor Detail

Button

public Button()

Constructor, by default has "Untitled" as title. Instantiates a JButton.

Button

public Button(java.lang.String title)

Constructor for the button with "title". Instantiates a JButton.

Parameters:

title - the title for the button, cannot be null

Method Detail

setTitle

public void setTitle(java.lang.String title)

Sets the title for the button.

Parameters:

title - the title for the button, cannot be null

getTitle

public java.lang.String getTitle()

Returns the title for the button.

Returns:

String title

enable

public void enable()

Enables this button.

disable

public void disable()

Disables this button.

onClick

public void onClick(java.lang.Object object)

Sets up the handler for what to do when this button is clicked. This method will call a method named "clicked"+getTitle() (if it exists) in the object. It is the developers responsibility that this object is valid and still exists when the button is clicked. The selection of the method to call occurs when the button is clicked, so changing the title of the button could in effect cause different methods to be called. If there is no method with the name "clicked"+getTitle() when the button is clicked, then the call on click does nothing.

Specified by:

onClick in interface ClickAction

Overrides:

onClick in class Widget

Parameters:

object - receives the call when clicked, must not be null

onClick

public void onClick(java.lang.Object object,
                    java.lang.String methodName)

Specifies the method to call in the parameter. All the caveats specified onClick apply. if the method doesn't exist, this will generate an exception (NoSuchMethod).

Specified by:

onClick in interface ClickAction

Overrides:

onClick in class Widget

Parameters:

object - receives the call upon click, can't be null

methodName - name of method to be called, can't be null

See Also:

apply. if the method doesn't exist, this will generate an exception (NoSuchMethod).

onClick

public void onClick(Command scl)

Same as @see CS2114.Button.onClick(Object, String) except uses a listener object of type Command.

Specified by:

onClick in interface ClickAction

Overrides:

onClick in class Widget

Parameters:

scl - command object, can't be null

remove

public void remove()

Specified by:

remove in class Widget