Crossfire JXClient, Trunk
Public Member Functions | Package Functions | Private Member Functions | Private Attributes | List of all members
com.realtime.crossfire.jxclient.gui.gui.Gui Class Reference
Collaboration diagram for com.realtime.crossfire.jxclient.gui.gui.Gui:
Collaboration graph

Public Member Functions

void activateDefaultElement ()
 
void autoSize (final int screenWidth, final int screenHeight)
 
boolean deactivateCommandInput ()
 
JComponent getComponent ()
 
AbstractGUIElement getElementFromPoint (final int x, final int y)
 
GUIPicture getHelp ()
 
KeyBindings getKeyBindings ()
 
 Gui (@NotNull final String name, @NotNull final KeyBindings keyBindings)
 
boolean handleKeyPress (@NotNull final KeyEvent2 e)
 
void hideInState (@NotNull final RendererGuiState state)
 
boolean isActiveElement (@Nullable final ActivatableGUIElement activeElement)
 
boolean isAutoSize ()
 
boolean isHidden (@NotNull final RendererGuiState state)
 
boolean isModal ()
 
boolean isSaveDialog ()
 
boolean isUserResizable ()
 
boolean isWithinDrawingArea (final int x, final int y)
 
void notifyOpen ()
 
void repaint ()
 
void setActiveElement (@NotNull final ActivatableGUIElement activeElement, final boolean active)
 
void setActiveElementActive (final boolean active)
 
void setAutoSize (@Nullable final Extent autoSize)
 
void setBounds (final int x, final int y, final int width, final int height, final int windowWidth, final int windowHeight)
 
void setDefaultPosition (@NotNull final Expression defaultX, @NotNull final Expression defaultY)
 
void setForcedActive (@Nullable final ActivatableGUIElement forcedActive)
 
void setGuiAutoCloseListener (@Nullable final GuiAutoCloseListener guiAutoCloseListener)
 
void setHelp (@NotNull final GUIPicture help)
 
void setModal (final boolean modal)
 
void setOpaqueDialogBackground (final boolean opaque)
 
void setSaveDialog ()
 
void setShowSentCommands (final boolean showSentCommands)
 
void setShowTimestamps (final boolean showTimestamps)
 
void setUserResizable (final boolean userResizable)
 
String toString ()
 

Package Functions

public< T extends GUIElement > T getFirstElement (@NotNull final Class< T > class_)
 
public< T extends GUIElement > T getFirstElement (@NotNull final Class< T > class_, @NotNull final String name)
 
public< T extends GUIElement > T getFirstElementEndingWith (@NotNull final Class< T > class_, @NotNull final String ending)
 
public< T extends GUIElement > T getFirstElementNotEndingWith (@NotNull final Class< T > class_, @NotNull final String ending)
 

Private Member Functions

ActivatableGUIElement getDefaultElement ()
 
void validate ()
 

Private Attributes

ActivatableGUIElement activeElement
 
Extent autoSize
 
final JComponent component
 
Expression defaultX
 
Expression defaultY
 
ActivatableGUIElement forcedActive
 
GuiAutoCloseListener guiAutoCloseListener
 
GUIPicture help
 
final Collection< RendererGuiState > hideInStates = EnumSet.noneOf(RendererGuiState.class)
 
boolean initialPositionSet
 
final KeyBindings keyBindings
 
boolean modal
 
boolean saveDialog
 
boolean userResizable
 

Detailed Description

Combines a list of GUIElements to for a gui.

A dialog can be modal. Such dialogs do not propagate key or mouse events to lower dialogs.

Author
Andreas Kirschbaum

Definition at line 49 of file Gui.java.

Constructor & Destructor Documentation

◆ Gui()

com.realtime.crossfire.jxclient.gui.gui.Gui.Gui ( @NotNull final String  name,
@NotNull final KeyBindings  keyBindings 
)

Creates a new instance.

Parameters
namethe name of this GUI
keyBindingsthe keybindings to use

Definition at line 151 of file Gui.java.

References com.realtime.crossfire.jxclient.gui.gui.Gui.component, and com.realtime.crossfire.jxclient.gui.gui.Gui.keyBindings.

Member Function Documentation

◆ activateDefaultElement()

void com.realtime.crossfire.jxclient.gui.gui.Gui.activateDefaultElement ( )

Activates the first default gui element of this gui.

Definition at line 238 of file Gui.java.

References com.realtime.crossfire.jxclient.gui.gui.Gui.getDefaultElement(), and com.realtime.crossfire.jxclient.gui.gui.ActivatableGUIElement.setActive().

Referenced by com.realtime.crossfire.jxclient.window.GuiManager.showGUIMeta().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ autoSize()

void com.realtime.crossfire.jxclient.gui.gui.Gui.autoSize ( final int  screenWidth,
final int  screenHeight 
)

Auto-resizes the dialog. This makes sure that the dialog is completely visible on the screen.

Parameters
screenWidththe screen width
screenHeightthe screen height

Definition at line 545 of file Gui.java.

References com.realtime.crossfire.jxclient.gui.gui.Gui.autoSize, com.realtime.crossfire.jxclient.gui.gui.Gui.component, com.realtime.crossfire.jxclient.gui.gui.Gui.defaultX, com.realtime.crossfire.jxclient.gui.gui.Gui.defaultY, com.realtime.crossfire.jxclient.gui.gui.Expression.evaluate(), com.realtime.crossfire.jxclient.gui.gui.Extent.getH(), com.realtime.crossfire.jxclient.gui.gui.Extent.getW(), com.realtime.crossfire.jxclient.gui.gui.Extent.getX(), com.realtime.crossfire.jxclient.gui.gui.Extent.getY(), com.realtime.crossfire.jxclient.gui.gui.Gui.initialPositionSet, com.realtime.crossfire.jxclient.util.SwingUtilities2.invokeAndWait(), com.realtime.crossfire.jxclient.gui.gui.Gui.setBounds(), and com.realtime.crossfire.jxclient.gui.gui.Gui.validate().

Here is the call graph for this function:

◆ deactivateCommandInput()

boolean com.realtime.crossfire.jxclient.gui.gui.Gui.deactivateCommandInput ( )

Deactivates the command text input field of this dialog. Does nothing if the command text input field is not active or if this dialog has no command text input field.

Returns
whether the command text input field has been deactivated

Definition at line 440 of file Gui.java.

References com.realtime.crossfire.jxclient.gui.gui.Gui.activeElement, com.realtime.crossfire.jxclient.gui.gui.GUIElement.getName(), and com.realtime.crossfire.jxclient.gui.gui.ActivatableGUIElement.setActive().

Referenced by com.realtime.crossfire.jxclient.gui.misc.JXCWindowRenderer.deactivateCommandInput().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getComponent()

JComponent com.realtime.crossfire.jxclient.gui.gui.Gui.getComponent ( )

Returns the JComponent for this instance.

Returns
the component

Definition at line 161 of file Gui.java.

References com.realtime.crossfire.jxclient.gui.gui.Gui.component.

Referenced by com.realtime.crossfire.jxclient.gui.misc.JXCWindowRenderer.endRendering(), com.realtime.crossfire.jxclient.skin.skin.GuiFactory.getElementX(), com.realtime.crossfire.jxclient.skin.skin.GuiFactory.getElementY(), com.realtime.crossfire.jxclient.gui.list.GUIList< GUICharacter >.getTooltip(), com.realtime.crossfire.jxclient.gui.misc.GUIDialogTitle.mousePressed(), com.realtime.crossfire.jxclient.gui.misc.GUIDialogBackground.mousePressed(), com.realtime.crossfire.jxclient.gui.misc.GUIDialogTitle.moveTo(), com.realtime.crossfire.jxclient.gui.misc.GUIDialogBackground.moveTo(), com.realtime.crossfire.jxclient.skin.skin.GuiFactory.newGui(), com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.newTooltipText(), com.realtime.crossfire.jxclient.gui.misc.JXCWindowRenderer.setCurrentGui(), com.realtime.crossfire.jxclient.gui.misc.JXCWindowRenderer.setResolutionPost(), and com.realtime.crossfire.jxclient.gui.misc.JXCWindowRenderer.updateWindowSize().

Here is the caller graph for this function:

◆ getDefaultElement()

ActivatableGUIElement com.realtime.crossfire.jxclient.gui.gui.Gui.getDefaultElement ( )
private

Returns the first default gui element of this gui.

Returns
the default gui element, or
null

Definition at line 220 of file Gui.java.

References com.realtime.crossfire.jxclient.gui.gui.Gui.component, and com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement.isDefault.

Referenced by com.realtime.crossfire.jxclient.gui.gui.Gui.activateDefaultElement(), and com.realtime.crossfire.jxclient.gui.gui.Gui.handleKeyPress().

Here is the caller graph for this function:

◆ getElementFromPoint()

AbstractGUIElement com.realtime.crossfire.jxclient.gui.gui.Gui.getElementFromPoint ( final int  x,
final int  y 
)

Determines the GUIElement for a given coordinate.

Parameters
xthe x-coordinate to check
ythe y-coordinate to check
Returns
the
GUIElement
at the given coordinate or
null
if none was found

Definition at line 323 of file Gui.java.

References com.realtime.crossfire.jxclient.gui.gui.Gui.component.

◆ getFirstElement() [1/2]

public<T extends GUIElement> T com.realtime.crossfire.jxclient.gui.gui.Gui.getFirstElement ( @NotNull final Class< T >  class_)
package

Returns the first gui element of this gui belonging to the given class.

Parameters
<T>the class to search for
class_the class to search for
Returns
the gui element or
null
if not found

Definition at line 300 of file Gui.java.

References com.realtime.crossfire.jxclient.gui.gui.Gui.component.

Referenced by com.realtime.crossfire.jxclient.gui.commands.AccountLinkCharacterCommand.execute(), com.realtime.crossfire.jxclient.gui.commands.AccountLoginCommand.execute(), com.realtime.crossfire.jxclient.gui.commands.AccountPlayCharacterCommand.execute(), com.realtime.crossfire.jxclient.gui.commands.AccountCreateCommand.execute(), com.realtime.crossfire.jxclient.gui.commands.AccountPasswordCommand.execute(), com.realtime.crossfire.jxclient.gui.commands.AccountCreateCharacterCommand.execute(), com.realtime.crossfire.jxclient.window.GuiManager.openQueryDialog(), com.realtime.crossfire.jxclient.window.GuiManager.setHideInput(), com.realtime.crossfire.jxclient.gui.misc.JXCWindowRenderer.setSelectedHostname(), and com.realtime.crossfire.jxclient.window.GuiManager.setSkin().

Here is the caller graph for this function:

◆ getFirstElement() [2/2]

public<T extends GUIElement> T com.realtime.crossfire.jxclient.gui.gui.Gui.getFirstElement ( @NotNull final Class< T >  class_,
@NotNull final String  name 
)
package

Returns the first gui element of this gui belonging to the given class and having the given name.

Parameters
<T>the class to search for
class_the class to search for
namethe button's name
Returns
the button or
null
if no button matches

Definition at line 464 of file Gui.java.

References com.realtime.crossfire.jxclient.gui.gui.Gui.component, and com.realtime.crossfire.jxclient.gui.gui.GUIElement.getName().

Here is the call graph for this function:

◆ getFirstElementEndingWith()

public<T extends GUIElement> T com.realtime.crossfire.jxclient.gui.gui.Gui.getFirstElementEndingWith ( @NotNull final Class< T >  class_,
@NotNull final String  ending 
)
package

Returns the first gui element of this gui which belongs to the given class and that's name ends with the given ending.

Parameters
<T>the class to search for
class_the class to search for
endingthe ending to search for
Returns
the gui element or
null
if not found

Definition at line 254 of file Gui.java.

References com.realtime.crossfire.jxclient.gui.gui.Gui.component, and com.realtime.crossfire.jxclient.gui.gui.GUIElement.getName().

Here is the call graph for this function:

◆ getFirstElementNotEndingWith()

public<T extends GUIElement> T com.realtime.crossfire.jxclient.gui.gui.Gui.getFirstElementNotEndingWith ( @NotNull final Class< T >  class_,
@NotNull final String  ending 
)
package

Returns the first gui element of this gui which belongs to the given class and that's name does not end with the given ending.

Parameters
<T>the class to search for
class_the class to search for
endingthe ending to search for
Returns
the gui element or
null
if not found

Definition at line 278 of file Gui.java.

References com.realtime.crossfire.jxclient.gui.gui.Gui.component, and com.realtime.crossfire.jxclient.gui.gui.GUIElement.getName().

Here is the call graph for this function:

◆ getHelp()

GUIPicture com.realtime.crossfire.jxclient.gui.gui.Gui.getHelp ( )

Returns the help icon of this dialog.

Returns
the help icon or
null
if this is not a dialog or if this dialog has no help icon

Definition at line 638 of file Gui.java.

References com.realtime.crossfire.jxclient.gui.gui.Gui.help.

◆ getKeyBindings()

KeyBindings com.realtime.crossfire.jxclient.gui.gui.Gui.getKeyBindings ( )

Returns the key bindings instance for this gui.

Returns
the key bindings

Definition at line 483 of file Gui.java.

References com.realtime.crossfire.jxclient.gui.gui.Gui.keyBindings.

◆ handleKeyPress()

boolean com.realtime.crossfire.jxclient.gui.gui.Gui.handleKeyPress ( @NotNull final KeyEvent2  e)

Dispatches a key press KeyEvent.

Parameters
ethe event to dispatch
Returns
whether a gui element did handle the event

Definition at line 401 of file Gui.java.

References com.realtime.crossfire.jxclient.gui.gui.ActivatableGUIElement.activateNextElement(), com.realtime.crossfire.jxclient.gui.gui.ActivatableGUIElement.activatePrevElement(), com.realtime.crossfire.jxclient.gui.gui.Gui.activeElement, com.realtime.crossfire.jxclient.gui.gui.ActivatableGUIElement.execute(), com.realtime.crossfire.jxclient.gui.gui.Gui.getDefaultElement(), com.realtime.crossfire.jxclient.gui.keybindings.KeyBindings.handleKeyPress(), com.realtime.crossfire.jxclient.gui.gui.Gui.keyBindings, com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.MASK, com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.NONE, and com.realtime.crossfire.jxclient.gui.keybindings.KeyEvent2.SHIFT.

Referenced by com.realtime.crossfire.jxclient.gui.misc.JXCWindowRenderer.handleKeyPress().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ hideInState()

void com.realtime.crossfire.jxclient.gui.gui.Gui.hideInState ( @NotNull final RendererGuiState  state)

Hides the dialog in a state.

Parameters
statethe state

Definition at line 491 of file Gui.java.

References com.realtime.crossfire.jxclient.gui.gui.Gui.hideInStates.

◆ isActiveElement()

boolean com.realtime.crossfire.jxclient.gui.gui.Gui.isActiveElement ( @Nullable final ActivatableGUIElement  activeElement)

Returns whether a given gui element is the active element of this dialog.

Parameters
activeElementthe gui element
Returns
whether the given gui element is active

Definition at line 381 of file Gui.java.

References com.realtime.crossfire.jxclient.gui.gui.Gui.activeElement.

Referenced by com.realtime.crossfire.jxclient.main.SkinLoader.loadSkin(), and com.realtime.crossfire.jxclient.gui.gui.Gui.setActiveElement().

Here is the caller graph for this function:

◆ isAutoSize()

boolean com.realtime.crossfire.jxclient.gui.gui.Gui.isAutoSize ( )

Returns whether this dialog is an auto-size dialog. Auto-size dialogs cannot be moved or resized manually.

Returns
whether this dialog is auto-size

Definition at line 179 of file Gui.java.

References com.realtime.crossfire.jxclient.gui.gui.Gui.autoSize.

Referenced by com.realtime.crossfire.jxclient.window.DialogStateParser.load(), com.realtime.crossfire.jxclient.gui.misc.GUIDialogBackground.mousePressed(), com.realtime.crossfire.jxclient.gui.misc.GUIDialogTitle.moveTo(), and com.realtime.crossfire.jxclient.gui.misc.GUIDialogBackground.moveTo().

Here is the caller graph for this function:

◆ isHidden()

boolean com.realtime.crossfire.jxclient.gui.gui.Gui.isHidden ( @NotNull final RendererGuiState  state)

Returns whether this gui is visible in a state.

Parameters
statethe state
Returns
whether this gui is hidden

Definition at line 500 of file Gui.java.

References com.realtime.crossfire.jxclient.gui.gui.Gui.hideInStates.

◆ isModal()

boolean com.realtime.crossfire.jxclient.gui.gui.Gui.isModal ( )

Returns the modal state.

Returns
the modal state

Definition at line 195 of file Gui.java.

References com.realtime.crossfire.jxclient.gui.gui.Gui.modal.

◆ isSaveDialog()

boolean com.realtime.crossfire.jxclient.gui.gui.Gui.isSaveDialog ( )

Returns whether this dialog retains its position across restarts.

Returns
whether this dialog retains its position across restarts

Definition at line 603 of file Gui.java.

References com.realtime.crossfire.jxclient.gui.gui.Gui.saveDialog.

Referenced by com.realtime.crossfire.jxclient.window.DialogStateParser.load().

Here is the caller graph for this function:

◆ isUserResizable()

boolean com.realtime.crossfire.jxclient.gui.gui.Gui.isUserResizable ( )

Returns whether the dialog is user-resizable.

Returns
whether the dialog is user-resizable

Definition at line 211 of file Gui.java.

References com.realtime.crossfire.jxclient.gui.gui.Gui.userResizable.

Referenced by com.realtime.crossfire.jxclient.gui.misc.GUIDialogBackground.mousePressed(), and com.realtime.crossfire.jxclient.gui.misc.GUIDialogBackground.moveTo().

Here is the caller graph for this function:

◆ isWithinDrawingArea()

boolean com.realtime.crossfire.jxclient.gui.gui.Gui.isWithinDrawingArea ( final int  x,
final int  y 
)

Returns whether a given point is within this dialog's drawing area.

Parameters
xthe x-coordinate of the point
ythe y-coordinate of the point
Returns
whether the coordinate is within the drawing area

Definition at line 519 of file Gui.java.

References com.realtime.crossfire.jxclient.gui.gui.Gui.component.

◆ notifyOpen()

void com.realtime.crossfire.jxclient.gui.gui.Gui.notifyOpen ( )

Call GUIElement#notifyOpen() for all GUI elements.

Definition at line 617 of file Gui.java.

References com.realtime.crossfire.jxclient.gui.gui.Gui.component, com.realtime.crossfire.jxclient.gui.gui.Gui.help, com.realtime.crossfire.jxclient.gui.misc.GUIPicture.notifyOpen(), and com.realtime.crossfire.jxclient.gui.gui.GUIElement.notifyOpen().

Here is the call graph for this function:

◆ repaint()

void com.realtime.crossfire.jxclient.gui.gui.Gui.repaint ( )

Repaints this component.

Definition at line 707 of file Gui.java.

References com.realtime.crossfire.jxclient.util.SwingUtilities2.invokeLater().

Here is the call graph for this function:

◆ setActiveElement()

void com.realtime.crossfire.jxclient.gui.gui.Gui.setActiveElement ( @NotNull final ActivatableGUIElement  activeElement,
final boolean  active 
)

Sets the gui element owning the focus.

Parameters
activeElementthe gui element
activethe new active state

Definition at line 339 of file Gui.java.

References com.realtime.crossfire.jxclient.gui.gui.ActivatableGUIElement.activeChanged(), com.realtime.crossfire.jxclient.gui.gui.Gui.activeElement, com.realtime.crossfire.jxclient.gui.gui.GuiAutoCloseListener.autoClosed(), com.realtime.crossfire.jxclient.gui.gui.Gui.forcedActive, com.realtime.crossfire.jxclient.gui.gui.Gui.guiAutoCloseListener, and com.realtime.crossfire.jxclient.gui.gui.Gui.isActiveElement().

Referenced by com.realtime.crossfire.jxclient.main.SkinLoader.loadSkin().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ setActiveElementActive()

void com.realtime.crossfire.jxclient.gui.gui.Gui.setActiveElementActive ( final boolean  active)

Activates or deactivates the GUI element owning the focus. Does nothing if no focus owner exists.

Parameters
activewhether to activate the GUI element

Definition at line 390 of file Gui.java.

References com.realtime.crossfire.jxclient.gui.gui.Gui.activeElement, and com.realtime.crossfire.jxclient.gui.gui.ActivatableGUIElement.setActive().

Here is the call graph for this function:

◆ setAutoSize()

void com.realtime.crossfire.jxclient.gui.gui.Gui.setAutoSize ( @Nullable final Extent  autoSize)

Sets the auto-size state. Auto-size dialogs cannot be moved or resized manually.

Parameters
autoSizethe new auto-size or
null

Definition at line 170 of file Gui.java.

References com.realtime.crossfire.jxclient.gui.gui.Gui.autoSize.

◆ setBounds()

void com.realtime.crossfire.jxclient.gui.gui.Gui.setBounds ( final int  x,
final int  y,
final int  width,
final int  height,
final int  windowWidth,
final int  windowHeight 
)

Sets the position and size of this dialog. The location may be modified to make sure the dialog is fully visible in the main window. The size will be increased if it is smaller than the allowed minimum size or decreased if it is larger than the allowed maximum size.

Parameters
xthe x-coordinate of the dialog
ythe y-coordinate of the dialog
widththe width of the dialog
heightthe height of the dialog
windowWidththe main window's width
windowHeightthe main window's height

Definition at line 662 of file Gui.java.

References com.realtime.crossfire.jxclient.gui.gui.Gui.component, com.realtime.crossfire.jxclient.gui.gui.Gui.initialPositionSet, and com.realtime.crossfire.jxclient.gui.gui.Gui.validate().

Referenced by com.realtime.crossfire.jxclient.gui.gui.Gui.autoSize(), com.realtime.crossfire.jxclient.window.DialogStateParser.load(), com.realtime.crossfire.jxclient.gui.misc.GUIDialogTitle.moveTo(), and com.realtime.crossfire.jxclient.gui.misc.GUIDialogBackground.moveTo().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ setDefaultPosition()

void com.realtime.crossfire.jxclient.gui.gui.Gui.setDefaultPosition ( @NotNull final Expression  defaultX,
@NotNull final Expression  defaultY 
)

Sets the default position for this dialog.

Parameters
defaultXthe default x-coordinate
defaultYthe default y-coordinate

Definition at line 594 of file Gui.java.

References com.realtime.crossfire.jxclient.gui.gui.Gui.defaultX, and com.realtime.crossfire.jxclient.gui.gui.Gui.defaultY.

◆ setForcedActive()

void com.realtime.crossfire.jxclient.gui.gui.Gui.setForcedActive ( @Nullable final ActivatableGUIElement  forcedActive)

Sets an ActivatableGUIElement that is always active. It prevents any other element from getting active.

Parameters
forcedActivethe element to set or
null
to unset

Definition at line 528 of file Gui.java.

References com.realtime.crossfire.jxclient.gui.gui.Gui.forcedActive.

◆ setGuiAutoCloseListener()

void com.realtime.crossfire.jxclient.gui.gui.Gui.setGuiAutoCloseListener ( @Nullable final GuiAutoCloseListener  guiAutoCloseListener)

Sets the GuiAutoCloseListener to be notified when this dialog becomes inactive.

Parameters
guiAutoCloseListenerthe listener to be notified or
null

Definition at line 509 of file Gui.java.

References com.realtime.crossfire.jxclient.gui.gui.Gui.guiAutoCloseListener.

◆ setHelp()

void com.realtime.crossfire.jxclient.gui.gui.Gui.setHelp ( @NotNull final GUIPicture  help)

Sets the help icon of this dialog.

Parameters
helpthe help icon

Definition at line 646 of file Gui.java.

References com.realtime.crossfire.jxclient.gui.gui.Gui.help.

◆ setModal()

void com.realtime.crossfire.jxclient.gui.gui.Gui.setModal ( final boolean  modal)

Sets the modal state.

Parameters
modalthe new modal state

Definition at line 187 of file Gui.java.

References com.realtime.crossfire.jxclient.gui.gui.Gui.modal.

◆ setOpaqueDialogBackground()

void com.realtime.crossfire.jxclient.gui.gui.Gui.setOpaqueDialogBackground ( final boolean  opaque)

Sets whether the dialog's background is opaque.

Parameters
opaquewhether the background is opaque

Definition at line 715 of file Gui.java.

References com.realtime.crossfire.jxclient.gui.gui.Gui.component, and com.realtime.crossfire.jxclient.gui.misc.GUIDialogBackground.setOpaqueDialogBackground().

Here is the call graph for this function:

◆ setSaveDialog()

void com.realtime.crossfire.jxclient.gui.gui.Gui.setSaveDialog ( )

Makes this dialog retain its position across restarts.

Definition at line 610 of file Gui.java.

References com.realtime.crossfire.jxclient.gui.gui.Gui.saveDialog.

◆ setShowSentCommands()

void com.realtime.crossfire.jxclient.gui.gui.Gui.setShowSentCommands ( final boolean  showSentCommands)

Sets whether the commands sent to the server should be shown in the messages dialog.

Parameters
showSentCommandswhether to show the commands

Definition at line 731 of file Gui.java.

References com.realtime.crossfire.jxclient.gui.gui.Gui.component.

◆ setShowTimestamps()

void com.realtime.crossfire.jxclient.gui.gui.Gui.setShowTimestamps ( final boolean  showTimestamps)

Sets whether timestamps should be shown in the messages dialog.

Parameters
showTimestampswhether to show timestamps

Definition at line 748 of file Gui.java.

References com.realtime.crossfire.jxclient.gui.gui.Gui.component.

◆ setUserResizable()

void com.realtime.crossfire.jxclient.gui.gui.Gui.setUserResizable ( final boolean  userResizable)

Sets whether the dialog is user-resizable.

Parameters
userResizablewhether the dialog is user-resizable

Definition at line 203 of file Gui.java.

References com.realtime.crossfire.jxclient.gui.gui.Gui.userResizable.

◆ toString()

String com.realtime.crossfire.jxclient.gui.gui.Gui.toString ( )

Definition at line 534 of file Gui.java.

References com.realtime.crossfire.jxclient.gui.gui.Gui.component.

◆ validate()

void com.realtime.crossfire.jxclient.gui.gui.Gui.validate ( )
private

Calls Container#validate() on the top-level frame.

Definition at line 693 of file Gui.java.

References com.realtime.crossfire.jxclient.gui.gui.Gui.component.

Referenced by com.realtime.crossfire.jxclient.gui.gui.Gui.autoSize(), and com.realtime.crossfire.jxclient.gui.gui.Gui.setBounds().

Here is the caller graph for this function:

Member Data Documentation

◆ activeElement

ActivatableGUIElement com.realtime.crossfire.jxclient.gui.gui.Gui.activeElement
private

The gui element which has the focus. Set to

null

if no such element exists.

Definition at line 111 of file Gui.java.

Referenced by com.realtime.crossfire.jxclient.gui.gui.Gui.deactivateCommandInput(), com.realtime.crossfire.jxclient.gui.gui.Gui.handleKeyPress(), com.realtime.crossfire.jxclient.gui.gui.Gui.isActiveElement(), com.realtime.crossfire.jxclient.gui.gui.Gui.setActiveElement(), and com.realtime.crossfire.jxclient.gui.gui.Gui.setActiveElementActive().

◆ autoSize

Extent com.realtime.crossfire.jxclient.gui.gui.Gui.autoSize
private

The extent of the dialog if it is auto-sizing or

null

otherwise. Auto-sizing dialogs cannot be moved or resized manually.

Definition at line 75 of file Gui.java.

Referenced by com.realtime.crossfire.jxclient.gui.gui.Gui.autoSize(), com.realtime.crossfire.jxclient.gui.gui.Gui.isAutoSize(), and com.realtime.crossfire.jxclient.gui.gui.Gui.setAutoSize().

◆ component

final JComponent com.realtime.crossfire.jxclient.gui.gui.Gui.component
private
Initial value:
= new JComponent() {
private static final long serialVersionUID = 1L;
}

The JComponent for this instance.

Definition at line 55 of file Gui.java.

Referenced by com.realtime.crossfire.jxclient.gui.gui.Gui.autoSize(), com.realtime.crossfire.jxclient.gui.gui.Gui.getComponent(), com.realtime.crossfire.jxclient.gui.gui.Gui.getDefaultElement(), com.realtime.crossfire.jxclient.gui.gui.Gui.getElementFromPoint(), com.realtime.crossfire.jxclient.gui.gui.Gui.getFirstElement(), com.realtime.crossfire.jxclient.gui.gui.Gui.getFirstElementEndingWith(), com.realtime.crossfire.jxclient.gui.gui.Gui.getFirstElementNotEndingWith(), com.realtime.crossfire.jxclient.gui.gui.Gui.Gui(), com.realtime.crossfire.jxclient.gui.gui.Gui.isWithinDrawingArea(), com.realtime.crossfire.jxclient.gui.gui.Gui.notifyOpen(), com.realtime.crossfire.jxclient.gui.gui.Gui.setBounds(), com.realtime.crossfire.jxclient.gui.gui.Gui.setOpaqueDialogBackground(), com.realtime.crossfire.jxclient.gui.gui.Gui.setShowSentCommands(), com.realtime.crossfire.jxclient.gui.gui.Gui.setShowTimestamps(), com.realtime.crossfire.jxclient.gui.gui.Gui.toString(), and com.realtime.crossfire.jxclient.gui.gui.Gui.validate().

◆ defaultX

Expression com.realtime.crossfire.jxclient.gui.gui.Gui.defaultX
private

The default x-coordinate for this dialog. Set to

null

for default.

Definition at line 130 of file Gui.java.

Referenced by com.realtime.crossfire.jxclient.gui.gui.Gui.autoSize(), and com.realtime.crossfire.jxclient.gui.gui.Gui.setDefaultPosition().

◆ defaultY

Expression com.realtime.crossfire.jxclient.gui.gui.Gui.defaultY
private

The default y-coordinate for this dialog. Set to

null

for default.

Definition at line 137 of file Gui.java.

Referenced by com.realtime.crossfire.jxclient.gui.gui.Gui.autoSize(), and com.realtime.crossfire.jxclient.gui.gui.Gui.setDefaultPosition().

◆ forcedActive

ActivatableGUIElement com.realtime.crossfire.jxclient.gui.gui.Gui.forcedActive
private

If non-

null

, this element is always active. No other element can become active.

Definition at line 104 of file Gui.java.

Referenced by com.realtime.crossfire.jxclient.gui.gui.Gui.setActiveElement(), and com.realtime.crossfire.jxclient.gui.gui.Gui.setForcedActive().

◆ guiAutoCloseListener

GuiAutoCloseListener com.realtime.crossfire.jxclient.gui.gui.Gui.guiAutoCloseListener
private

If set, the auto-close listener to notify if this dialog looses the active gui element.

Definition at line 123 of file Gui.java.

Referenced by com.realtime.crossfire.jxclient.gui.gui.Gui.setActiveElement(), and com.realtime.crossfire.jxclient.gui.gui.Gui.setGuiAutoCloseListener().

◆ help

GUIPicture com.realtime.crossfire.jxclient.gui.gui.Gui.help
private

The help icon of the dialog. Set to

null

if this GUI is not a dialog or has no such help icon.

Definition at line 144 of file Gui.java.

Referenced by com.realtime.crossfire.jxclient.gui.gui.Gui.getHelp(), com.realtime.crossfire.jxclient.gui.gui.Gui.notifyOpen(), and com.realtime.crossfire.jxclient.gui.gui.Gui.setHelp().

◆ hideInStates

final Collection<RendererGuiState> com.realtime.crossfire.jxclient.gui.gui.Gui.hideInStates = EnumSet.noneOf(RendererGuiState.class)
private

The gui states that do not show this dialog.

Definition at line 97 of file Gui.java.

Referenced by com.realtime.crossfire.jxclient.gui.gui.Gui.hideInState(), and com.realtime.crossfire.jxclient.gui.gui.Gui.isHidden().

◆ initialPositionSet

boolean com.realtime.crossfire.jxclient.gui.gui.Gui.initialPositionSet
private

Whether an initial position has been set.

Definition at line 116 of file Gui.java.

Referenced by com.realtime.crossfire.jxclient.gui.gui.Gui.autoSize(), and com.realtime.crossfire.jxclient.gui.gui.Gui.setBounds().

◆ keyBindings

final KeyBindings com.realtime.crossfire.jxclient.gui.gui.Gui.keyBindings
private

The KeyBindings for this gui.

Definition at line 68 of file Gui.java.

Referenced by com.realtime.crossfire.jxclient.gui.gui.Gui.getKeyBindings(), com.realtime.crossfire.jxclient.gui.gui.Gui.Gui(), and com.realtime.crossfire.jxclient.gui.gui.Gui.handleKeyPress().

◆ modal

boolean com.realtime.crossfire.jxclient.gui.gui.Gui.modal
private

Whether this dialog is modal. Modal dialogs consume all key presses.

Definition at line 85 of file Gui.java.

Referenced by com.realtime.crossfire.jxclient.gui.gui.Gui.isModal(), and com.realtime.crossfire.jxclient.gui.gui.Gui.setModal().

◆ saveDialog

boolean com.realtime.crossfire.jxclient.gui.gui.Gui.saveDialog
private

Whether this dialog retains its position across restarts.

Definition at line 80 of file Gui.java.

Referenced by com.realtime.crossfire.jxclient.gui.gui.Gui.isSaveDialog(), and com.realtime.crossfire.jxclient.gui.gui.Gui.setSaveDialog().

◆ userResizable

boolean com.realtime.crossfire.jxclient.gui.gui.Gui.userResizable
private

Whether this dialog is user-resizable. User-resizable dialogs can be resized by dragging the border of the dialog.

Definition at line 91 of file Gui.java.

Referenced by com.realtime.crossfire.jxclient.gui.gui.Gui.isUserResizable(), and com.realtime.crossfire.jxclient.gui.gui.Gui.setUserResizable().

The documentation for this class was generated from the following file:
Generated by   doxygen 1.8.17