Skip to content

Commit

Permalink
(doc) Add documentation to FxRobotInterface
Browse files Browse the repository at this point in the history
  • Loading branch information
@JordanMartinez
JordanMartinez committed Dec 8, 2016
1 parent 7ab75cf commit 1189044
Show file tree
Hide file tree
Showing 2 changed files with 233 additions and 25 deletions.
25 changes: 0 additions & 25 deletions subprojects/testfx-core/src/main/java/org/testfx/api/FxRobot.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -576,36 +576,31 @@ public FxRobot interrupt(int attemptsCount) {
//---------------------------------------------------------------------------------------------

@Override
@Unstable(reason = "is missing apidocs")
public FxRobot push(KeyCode... combination) {
context.getTypeRobot().push(combination);
return this;
}

@Override
@Unstable(reason = "is missing apidocs")
public FxRobot push(KeyCodeCombination combination) {
context.getTypeRobot().push(combination);
return this;
}

@Override
@Unstable(reason = "is missing apidocs")
public FxRobot type(KeyCode... keyCodes) {
context.getTypeRobot().type(keyCodes);
return this;
}

@Override
@Unstable(reason = "is missing apidocs")
public FxRobot type(KeyCode keyCode,
int times) {
context.getTypeRobot().type(keyCode, times);
return this;
}

@Override
@Unstable(reason = "is missing apidocs")
public FxRobot eraseText(int amount) {
return type(KeyCode.BACK_SPACE, amount);
}
Expand All @@ -620,14 +615,12 @@ public FxRobot closeCurrentWindow() {
//---------------------------------------------------------------------------------------------

@Override
@Unstable(reason = "is missing apidocs")
public FxRobot write(char character) {
context.getWriteRobot().write(character);
return this;
}

@Override
@Unstable(reason = "is missing apidocs")
public FxRobot write(String text) {
context.getWriteRobot().write(text);
return this;
Expand All @@ -638,14 +631,12 @@ public FxRobot write(String text) {
//---------------------------------------------------------------------------------------------

@Override
@Unstable(reason = "is missing apidocs")
public FxRobot sleep(long milliseconds) {
context.getSleepRobot().sleep(milliseconds);
return this;
}

@Override
@Unstable(reason = "is missing apidocs")
public FxRobot sleep(long duration,
TimeUnit timeUnit) {
context.getSleepRobot().sleep(duration, timeUnit);
Expand All @@ -657,37 +648,32 @@ public FxRobot sleep(long duration,
//---------------------------------------------------------------------------------------------

@Deprecated
@Unstable(reason = "is missing apidocs")
public FxRobot scroll(int amount) {
context.getScrollRobot().scroll(amount);
return this;
}

@Override
@Unstable(reason = "is missing apidocs")
public FxRobot scroll(int amount,
VerticalDirection direction) {
context.getScrollRobot().scroll(amount, direction);
return this;
}

@Override
@Unstable(reason = "is missing apidocs")
public FxRobot scroll(VerticalDirection direction) {
scroll(1, direction);
return this;
}

@Override
@Unstable(reason = "is missing apidocs")
public FxRobot scroll(int amount,
HorizontalDirection direction) {
context.getScrollRobot().scroll(amount, direction);
return this;
}

@Override
@Unstable(reason = "is missing apidocs")
public FxRobot scroll(HorizontalDirection direction) {
scroll(1, direction);
return this;
Expand Down Expand Up @@ -734,29 +720,25 @@ public FxRobot release(MouseButton... buttons) {
//---------------------------------------------------------------------------------------------

@Override
@Unstable(reason = "is missing apidocs")
public FxRobot clickOn(MouseButton... buttons) {
context.getClickRobot().clickOn(buttons);
return this;
}

@Override
@Unstable(reason = "is missing apidocs")
public FxRobot clickOn(PointQuery pointQuery,
MouseButton... buttons) {
context.getClickRobot().clickOn(pointQuery, buttons);
return this;
}

@Override
@Unstable(reason = "is missing apidocs")
public FxRobot doubleClickOn(MouseButton... buttons) {
context.getClickRobot().doubleClickOn(buttons);
return this;
}

@Override
@Unstable(reason = "is missing apidocs")
public FxRobot doubleClickOn(PointQuery pointQuery,
MouseButton... buttons) {
context.getClickRobot().doubleClickOn(pointQuery, buttons);
Expand Down Expand Up @@ -963,36 +945,31 @@ public <T extends Node> FxRobot doubleClickOn(Predicate<T> predicate,
//---------------------------------------------------------------------------------------------

@Override
@Unstable(reason = "is missing apidocs")
public FxRobot drag(MouseButton... buttons) {
context.getDragRobot().drag(buttons);
return this;
}

@Override
@Unstable(reason = "is missing apidocs")
public FxRobot drag(PointQuery pointQuery,
MouseButton... buttons) {
context.getDragRobot().drag(pointQuery, buttons);
return this;
}

@Override
@Unstable(reason = "is missing apidocs")
public FxRobot drop() {
context.getDragRobot().drop();
return this;
}

@Override
@Unstable(reason = "is missing apidocs")
public FxRobot dropTo(PointQuery pointQuery) {
context.getDragRobot().dropTo(pointQuery);
return this;
}

@Override
@Unstable(reason = "is missing apidocs")
public FxRobot dropBy(double x,
double y) {
context.getDragRobot().dropBy(x, y);
Expand Down Expand Up @@ -1123,14 +1100,12 @@ public <T extends Node> FxRobot dropTo(Predicate<T> predicate) {
//---------------------------------------------------------------------------------------------

@Override
@Unstable(reason = "is missing apidocs")
public FxRobot moveTo(PointQuery pointQuery) {
context.getMoveRobot().moveTo(pointQuery);
return this;
}

@Override
@Unstable(reason = "is missing apidocs")
public FxRobot moveBy(double x,
double y) {
context.getMoveRobot().moveBy(x, y);
Expand Down

0 comments on commit 1189044

Please sign in to comment.