Crossfire JXClient, Trunk  R20561
ScrollCommand.java
Go to the documentation of this file.
1 /*
2  * This file is part of JXClient, the Fullscreen Java Crossfire Client.
3  *
4  * JXClient is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation; either version 2 of the License, or
7  * (at your option) any later version.
8  *
9  * JXClient is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with JXClient; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
17  *
18  * Copyright (C) 2005-2008 Yann Chachkoff.
19  * Copyright (C) 2006-2011 Andreas Kirschbaum.
20  */
21 
22 package com.realtime.crossfire.jxclient.gui.commands;
23 
26 import org.jetbrains.annotations.NotNull;
27 
33 public class ScrollCommand implements GUICommand {
34 
38  private final int distance;
39 
43  @NotNull
44  private final GUIScrollable scrollable;
45 
51  public ScrollCommand(final int distance, @NotNull final GUIScrollable scrollable) {
52  this.distance = distance;
53  this.scrollable = scrollable;
54  }
55 
59  @Override
60  public boolean canExecute() {
61  return scrollable.canScroll(distance);
62  }
63 
67  @Override
68  public void execute() {
69  scrollable.scroll(distance);
70  }
71 
72 }
ScrollCommand(final int distance, @NotNull final GUIScrollable scrollable)
Creates a new instance.
void execute()
Executes the command.Does nothing if called while canExecute() returnsfalse .
boolean canExecute()
Returns whether this command may be executed.whether this command may be executed ...
void scroll(int distance)
Scrolls the element.
boolean canScroll(int distance)
Returns whether scrolling is possible.
final GUIScrollable scrollable
The scrollable element.
A GUICommand which scrolls a GUIScrollable gui element by a given distance.
Interface for GUIElements that support scrolling.