Crossfire JXClient, Trunk
Public Member Functions | Protected Member Functions | Static Private Attributes | List of all members
com.realtime.crossfire.jxclient.gui.button.GUIButton Class Reference
Inheritance diagram for com.realtime.crossfire.jxclient.gui.button.GUIButton:
Inheritance graph
Collaboration diagram for com.realtime.crossfire.jxclient.gui.button.GUIButton:
Collaboration graph

Public Member Functions

void activeChanged ()
 
 GUIButton (@NotNull final TooltipManager tooltipManager, @NotNull final GUIElementListener elementListener, @NotNull final String name, @NotNull final BufferedImage imageUp, @NotNull final BufferedImage imageDown, @Nullable final String text, @Nullable final Font font, @Nullable final Color color, final int textX, final int textY, final boolean autoRepeat, @NotNull final CommandList commandList, @NotNull final GuiFactory guiFactory, @NotNull final NewCharModel newCharModel)
 
void notifyOpen ()
 
- Public Member Functions inherited from com.realtime.crossfire.jxclient.gui.button.AbstractButton2
Dimension getMaximumSize ()
 
TooltipText getTooltip ()
 
void paintComponent (@NotNull final Graphics g)
 
- Public Member Functions inherited from com.realtime.crossfire.jxclient.gui.button.AbstractButton
void dispose ()
 
void execute ()
 
Dimension getMinimumSize ()
 
Dimension getPreferredSize ()
 
boolean keyPressed (@NotNull final KeyEvent2 e)
 
void mouseClicked (@NotNull final MouseEvent e)
 
void mouseExited (@NotNull final MouseEvent e)
 
void mousePressed (@NotNull final MouseEvent e)
 
void mouseReleased (@NotNull final MouseEvent e)
 
- Public Member Functions inherited from com.realtime.crossfire.jxclient.gui.gui.ActivatableGUIElement
void activateNextElement ()
 
void activatePrevElement ()
 
boolean isActive ()
 
void setActive (final boolean active)
 
void setNextActive (@NotNull final ActivatableGUIElement next)
 
void setPrevActive (@NotNull final ActivatableGUIElement prev)
 
- Public Member Functions inherited from com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement
int getDialogBorderBottom ()
 
int getDialogBorderLeft ()
 
int getDialogBorderRight ()
 
int getDialogBorderTop ()
 
String getName ()
 
void inhibitListeners ()
 
boolean isDefault ()
 
boolean isIgnore ()
 
void mouseDragged (@NotNull final MouseEvent e)
 
void mouseEntered (@NotNull final MouseEvent e)
 
void mouseMoved (@NotNull final MouseEvent e)
 
void mouseWheelMoved (final int wheelRotation)
 
void setChanged ()
 
void setChangedListener (@Nullable final GUIElementChangedListener changedListener)
 
void setDefault (final boolean isDefault)
 
void setIgnore ()
 
String toString ()
 

Protected Member Functions

boolean isSelected ()
 
- Protected Member Functions inherited from com.realtime.crossfire.jxclient.gui.button.AbstractButton2
 AbstractButton2 (@NotNull final TooltipManager tooltipManager, @NotNull final GUIElementListener elementListener, @NotNull final String name, @NotNull final BufferedImage imageUp, @NotNull final BufferedImage imageDown, @Nullable final String text, @Nullable final Font font, @Nullable final Color color, final int textX, final int textY, final boolean autoRepeat, @NotNull final CommandList commandList, @NotNull final GuiFactory guiFactory, @NotNull final NewCharModel newCharModel)
 
Dimension getMinimumSizeInt ()
 
- Protected Member Functions inherited from com.realtime.crossfire.jxclient.gui.button.AbstractButton
 AbstractButton (@NotNull final TooltipManager tooltipManager, @NotNull final GUIElementListener elementListener, @NotNull final String name, final boolean opaque, final boolean autoRepeat, @NotNull final CommandList commandList, @NotNull final GuiFactory guiFactory, @NotNull final NewCharModel newCharModel)
 
- Protected Member Functions inherited from com.realtime.crossfire.jxclient.gui.gui.ActivatableGUIElement
 ActivatableGUIElement (@NotNull final TooltipManager tooltipManager, @NotNull final GUIElementListener elementListener, @NotNull final String name, final boolean opaque, @NotNull final GuiFactory guiFactory)
 
void markInactivePending ()
 
void setInactiveIfPending ()
 
- Protected Member Functions inherited from com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement
 AbstractGUIElement (@NotNull final TooltipManager tooltipManager, @NotNull final GUIElementListener elementListener, @NotNull final String name, final boolean opaque, @NotNull final GuiFactory guiFactory)
 
TooltipText newTooltipText (@Nullable final String tooltipText)
 
void tooltipChanged ()
 

Static Private Attributes

static final long serialVersionUID = 1
 

Detailed Description

A GUIElement that implements a button. The button shows an image and optionally overlays a text string.

Author
Lauwenmark
Andreas Kirschbaum

Definition at line 43 of file GUIButton.java.

Constructor & Destructor Documentation

◆ GUIButton()

com.realtime.crossfire.jxclient.gui.button.GUIButton.GUIButton ( @NotNull final TooltipManager  tooltipManager,
@NotNull final GUIElementListener  elementListener,
@NotNull final String  name,
@NotNull final BufferedImage  imageUp,
@NotNull final BufferedImage  imageDown,
@Nullable final String  text,
@Nullable final Font  font,
@Nullable final Color  color,
final int  textX,
final int  textY,
final boolean  autoRepeat,
@NotNull final CommandList  commandList,
@NotNull final GuiFactory  guiFactory,
@NotNull final NewCharModel  newCharModel 
)

Creates a new instance. Both

and

must have the same size. The x/y coordinates specify the baseline of the first character of the overlay text.

Parameters
tooltipManagerthe tooltip manager to update
elementListenerthe element listener to notify
namethe name of this element
imageUpthe image in unselected state
imageDownthe image in selected state
textthe overlay text or
null
to display only the image
fontthe font for the overlay text or
null
to display only the image
colorthe color of the overlay text or
null
to display only the image
textXthe x coordinate of the overlay text
textYthe y coordinate of the overlay text
autoRepeatwhether the button should autorepeat while being pressed
commandListthe commands to execute when the button is elected
guiFactorythe global GUI factory instance
newCharModelthe global new char model instance

Definition at line 72 of file GUIButton.java.

References com.realtime.crossfire.jxclient.gui.button.AbstractButton.autoRepeat, com.realtime.crossfire.jxclient.gui.button.AbstractButton2.color, com.realtime.crossfire.jxclient.gui.button.AbstractButton.commandList, com.realtime.crossfire.jxclient.gui.gui.ActivatableGUIElement.elementListener, com.realtime.crossfire.jxclient.gui.button.AbstractButton2.font, com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.guiFactory, com.realtime.crossfire.jxclient.gui.button.AbstractButton2.imageDown, com.realtime.crossfire.jxclient.gui.button.AbstractButton2.imageUp, com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.name, com.realtime.crossfire.jxclient.gui.button.AbstractButton.newCharModel, com.realtime.crossfire.jxclient.gui.button.AbstractButton2.text, com.realtime.crossfire.jxclient.gui.button.AbstractButton2.textX, com.realtime.crossfire.jxclient.gui.button.AbstractButton2.textY, and com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.tooltipManager.

Member Function Documentation

◆ activeChanged()

void com.realtime.crossfire.jxclient.gui.button.GUIButton.activeChanged ( )

Will be called whenever the active state has changed.

Reimplemented from com.realtime.crossfire.jxclient.gui.gui.ActivatableGUIElement.

Definition at line 77 of file GUIButton.java.

References com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.setChanged().

Here is the call graph for this function:

◆ isSelected()

boolean com.realtime.crossfire.jxclient.gui.button.GUIButton.isSelected ( )
protected

Returns which image should be shown.

Returns
false=show "up" image, true=show "down" image

Reimplemented from com.realtime.crossfire.jxclient.gui.button.AbstractButton2.

Definition at line 82 of file GUIButton.java.

References com.realtime.crossfire.jxclient.gui.gui.ActivatableGUIElement.isActive().

Here is the call graph for this function:

◆ notifyOpen()

void com.realtime.crossfire.jxclient.gui.button.GUIButton.notifyOpen ( )

Called each time the enclosing dialog is opened (or raised).

Implements com.realtime.crossfire.jxclient.gui.gui.GUIElement.

Definition at line 87 of file GUIButton.java.

Member Data Documentation

◆ serialVersionUID

final long com.realtime.crossfire.jxclient.gui.button.GUIButton.serialVersionUID = 1
staticprivate

The serial version UID.

Definition at line 48 of file GUIButton.java.


The documentation for this class was generated from the following file:
com.realtime.crossfire.jxclient.gui.button.AbstractButton2.imageDown
final Image imageDown
Definition: AbstractButton2.java:64
com.realtime.crossfire.jxclient.gui.button.AbstractButton2.imageUp
final Image imageUp
Definition: AbstractButton2.java:58