com.realtime.crossfire.jxclient.gui.misc

Class GUIDialogBackground

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement

com.realtime.crossfire.jxclient.gui.misc.GUIDialogBackground

All Implemented Interfaces:

GUIElement, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable

public class GUIDialogBackground
extends AbstractGUIElement

A background image for dialog windows.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description

GUIDialogBackground(@NotNull TooltipManager tooltipManager, @NotNull JXCWindowRenderer windowRenderer, @NotNull GUIElementListener elementListener, @NotNull java.lang.String name, float alpha, @NotNull java.awt.Image frameNW, @NotNull java.awt.Image frameN, @NotNull java.awt.Image frameNE, @NotNull java.awt.Image frameW, @NotNull java.awt.Image frameC, @NotNull java.awt.Image frameE, @NotNull java.awt.Image frameSW, @NotNull java.awt.Image frameS, @NotNull java.awt.Image frameSE, @NotNull GuiFactory guiFactory) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
int	getDialogBorderBottom() Returns the size of the dialog's bottom border.
int	getDialogBorderLeft() Returns the size of the dialog's left border.
int	getDialogBorderRight() Returns the size of the dialog's right border.
int	getDialogBorderTop() Returns the size of the dialog's top border.
@Nullable java.awt.Dimension	getMinimumSize()
@Nullable java.awt.Dimension	getPreferredSize()
@Nullable TooltipText	getTooltip() Returns the current tooltip text.
void	mouseDragged(@NotNull java.awt.event.MouseEvent e) Will be called when the mouse moves within this component while the button is pressed.
void	mousePressed(@NotNull java.awt.event.MouseEvent e) Will be called when the user has pressed the mouse inside this element.
void	mouseReleased(@NotNull java.awt.event.MouseEvent e) Will be called when the user has released the mouse.
void	notifyOpen() Called each time the enclosing dialog is opened (or raised).
void	paintComponent(@NotNull java.awt.Graphics g)
void	setOpaqueDialogBackground(boolean opaque) Sets whether the dialog's background is opaque.

Methods inherited from class com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement

dispose, getName, inhibitListeners, isDefault, isIgnore, mouseClicked, mouseEntered, mouseExited, mouseMoved, mouseWheelMoved, newTooltipText, setChanged, setChangedListener, setDefault, setIgnore, tooltipChanged, toString

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getNextFocusableComponent, getPopupLocation, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAccessibleContext, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

GUIDialogBackground

public GUIDialogBackground(@NotNull
                           @NotNull TooltipManager tooltipManager,
                           @NotNull
                           @NotNull JXCWindowRenderer windowRenderer,
                           @NotNull
                           @NotNull GUIElementListener elementListener,
                           @NotNull
                           @NotNull java.lang.String name,
                           float alpha,
                           @NotNull
                           @NotNull java.awt.Image frameNW,
                           @NotNull
                           @NotNull java.awt.Image frameN,
                           @NotNull
                           @NotNull java.awt.Image frameNE,
                           @NotNull
                           @NotNull java.awt.Image frameW,
                           @NotNull
                           @NotNull java.awt.Image frameC,
                           @NotNull
                           @NotNull java.awt.Image frameE,
                           @NotNull
                           @NotNull java.awt.Image frameSW,
                           @NotNull
                           @NotNull java.awt.Image frameS,
                           @NotNull
                           @NotNull java.awt.Image frameSE,
                           @NotNull
                           @NotNull GuiFactory guiFactory)

Creates a new instance.

Parameters:

tooltipManager - the tooltip manager to update

windowRenderer - the window renderer this element belongs to

elementListener - the element listener to notify

name - the name of this element

alpha - the alpha value for the background, 1 is opaque, 0 full transparent

frameNW - the north-west frame picture

frameN - the north frame picture

frameNE - the north-east frame picture

frameW - the west frame picture

frameC - the center frame picture

frameE - the east frame picture

frameSW - the south-west frame picture

frameS - the south frame picture

frameSE - the south-east frame picture

guiFactory - the global GUI factory instance

Method Detail

setOpaqueDialogBackground

public void setOpaqueDialogBackground(boolean opaque)

Sets whether the dialog's background is opaque.

Parameters:

opaque - whether the background is opaque

paintComponent

public void paintComponent(@NotNull
                           @NotNull java.awt.Graphics g)

Overrides:

paintComponent in class javax.swing.JComponent

getPreferredSize

@Nullable
public @Nullable java.awt.Dimension getPreferredSize()

Overrides:

getPreferredSize in class javax.swing.JComponent

getMinimumSize

@Nullable
public @Nullable java.awt.Dimension getMinimumSize()

Overrides:

getMinimumSize in class javax.swing.JComponent

notifyOpen

public void notifyOpen()

Description copied from interface: GUIElement

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

getTooltip

@Nullable
public @Nullable TooltipText getTooltip()

Description copied from class: AbstractGUIElement

Returns the current tooltip text.

Specified by:

getTooltip in class AbstractGUIElement

Returns:

the tooltip text or null to not show a tooltip

getDialogBorderTop

public int getDialogBorderTop()

Description copied from class: AbstractGUIElement

Returns the size of the dialog's top border.

Overrides:

getDialogBorderTop in class AbstractGUIElement

Returns:

the size in pixels or 0 if this GUI element is not a dialog

getDialogBorderLeft

public int getDialogBorderLeft()

Description copied from class: AbstractGUIElement

Returns the size of the dialog's left border.

Overrides:

getDialogBorderLeft in class AbstractGUIElement

Returns:

the size in pixels or 0 if this GUI element is not a dialog

getDialogBorderRight

public int getDialogBorderRight()

Description copied from class: AbstractGUIElement

Returns the size of the dialog's right border.

Overrides:

getDialogBorderRight in class AbstractGUIElement

Returns:

the size in pixels or 0 if this GUI element is not a dialog

getDialogBorderBottom

public int getDialogBorderBottom()

Description copied from class: AbstractGUIElement

Returns the size of the dialog's bottom border.

Overrides:

getDialogBorderBottom in class AbstractGUIElement

Returns:

the size in pixels or 0 if this GUI element is not a dialog

mousePressed

public void mousePressed(@NotNull
                         @NotNull java.awt.event.MouseEvent e)

Description copied from interface: GUIElement

Will be called when the user has pressed the mouse inside this element.

Specified by:

mousePressed in interface GUIElement

Overrides:

mousePressed in class AbstractGUIElement

Parameters:

e - the mouse event relative to this element

mouseReleased

public void mouseReleased(@NotNull
                          @NotNull java.awt.event.MouseEvent e)

Description copied from interface: GUIElement

Will be called when the user has released the mouse. This event may be delivered even if no previous GUIElement.mousePressed(MouseEvent) has been delivered before.

Specified by:

mouseReleased in interface GUIElement

Overrides:

mouseReleased in class AbstractGUIElement

Parameters:

e - the mouse event relative to this element

mouseDragged

public void mouseDragged(@NotNull
                         @NotNull java.awt.event.MouseEvent e)

Description copied from interface: GUIElement

Will be called when the mouse moves within this component while the button is pressed. This event will be delivered after GUIElement.mouseMoved(MouseEvent).

Note: if the mouse leaves this element's bounding box while the mouse button is still pressed, further mouseDragged (but no mouseMoved) events will be generated.

Specified by:

mouseDragged in interface GUIElement

Overrides:

mouseDragged in class AbstractGUIElement

Parameters:

e - the mouse event relative to this element