Skip to content

Commit

Permalink
(doc) Add javadoc to ScrollRobot
Browse files Browse the repository at this point in the history
  • Loading branch information
JordanMartinez committed Dec 3, 2016
1 parent f564b62 commit e346f0b
Showing 1 changed file with 37 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -21,19 +21,56 @@

public interface ScrollRobot {

/**
* Scrolls vertically by amount (in terms of ticks of a mouse wheel): if {@code amount >= 0}, up; otherwise, down.
*
* @param amount of a mouse wheel's scroll ticks
*/
void scroll(int amount);

/**
* Scrolls vertically by amount (in terms of ticks of a mouse wheel) in given direction.
*
* @param positiveAmount the number of scroll ticks
* @param direction whether to scroll up or down
*/
void scroll(int positiveAmount,
VerticalDirection direction);

/**
* Scrolls up by amount (in terms of ticks of a mouse wheel).
* .
* @param positiveAmount the number of scroll ticks
*/
void scrollUp(int positiveAmount);

/**
* Scrolls down by amount (in terms of ticks of a wheel).
*
* @param positiveAmount the number of scroll ticks
*/
void scrollDown(int positiveAmount);

/**
* Scrolls horizontally by amount (in terms of ticks of a mouse wheel) in given direction.
*
* @param positiveAmount the number of scroll ticks
* @param direction whether to scroll left or right
*/
void scroll(int positiveAmount,
HorizontalDirection direction);

/**
* Scrolls left by amount (in terms of ticks of a wheel).
*
* @param positiveAmount the number of scroll ticks
*/
void scrollLeft(int positiveAmount);

/**
* Scrolls right by amount (in terms of ticks of a wheel).
*
* @param positiveAmount the number of scroll ticks
*/
void scrollRight(int positiveAmount);
}

0 comments on commit e346f0b

Please sign in to comment.