Button (2013 FRC Java API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

"
2013 FRC Java API
"

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

edu.wpi.first.wpilibj.buttons
Class Button

java.lang.Object
  edu.wpi.first.wpilibj.buttons.Trigger
      edu.wpi.first.wpilibj.buttons.Button

All Implemented Interfaces:: Sendable

Direct Known Subclasses:: DigitalIOButton, InternalButton, JoystickButton, NetworkButton

public abstract class Button
extends Trigger
extends Trigger

This class provides an easy way to link commands to OI inputs. It is very easy to link a button to a command. For instance, you could link the trigger button of a joystick to a "score" command. This class represents a subclass of Trigger that is specifically aimed at buttons on an operator interface as a common use case of the more generalized Trigger objects. This is a simple wrapper around Trigger with the method names renamed to fit the Button object use.

Author:: brad

Nested Class Summary

Nested classes/interfaces inherited from class edu.wpi.first.wpilibj.buttons.Trigger
`Trigger.ButtonScheduler`

Constructor Summary
`Button()`

Method Summary
`void`	`cancelWhenPressed(Command command)` Cancel the command when the button is pressed
`void`	`toggleWhenPressed(Command command)` Toggles the command whenever the button is pressed (on then off then on)
`void`	`whenPressed(Command command)` Starts the given command whenever the button is newly pressed.
`void`	`whenReleased(Command command)` Starts the command when the button is released
`void`	`whileHeld(Command command)` Constantly starts the given command while the button is held.

Methods inherited from class edu.wpi.first.wpilibj.buttons.Trigger
`cancelWhenActive, get, getSmartDashboardType, getTable, initTable, toggleWhenActive, whenActive, whenInactive, whileActive`

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

Button

public Button()

Method Detail

whenPressed

public void whenPressed(Command command)

Starts the given command whenever the button is newly pressed.

Parameters:: command - the command to start

whileHeld

public void whileHeld(Command command)

Constantly starts the given command while the button is held. Command.start() will be called repeatedly while the button is held, and will be canceled when the button is released.

Parameters:: command - the command to start

whenReleased

public void whenReleased(Command command)

Starts the command when the button is released

Parameters:: command - the command to start

toggleWhenPressed

public void toggleWhenPressed(Command command)

Toggles the command whenever the button is pressed (on then off then on)

Parameters:: command -

cancelWhenPressed

public void cancelWhenPressed(Command command)

Cancel the command when the button is pressed

Parameters:: command -