Gridarta Editor
net.sf.gridarta.gui.utils.FaceComponent Class Reference

A JPanel that allows the user to select a face name. More...

+ Inheritance diagram for net.sf.gridarta.gui.utils.FaceComponent:
+ Collaboration diagram for net.sf.gridarta.gui.utils.FaceComponent:

Public Member Functions

 FaceComponent (@NotNull final String faceName, @NotNull final FaceObjects faceObjects, @NotNull final FaceObjectProviders faceObjectProviders, @NotNull final ImageIcon noFaceSquareIcon, @NotNull final ImageIcon unknownSquareIcon, @NotNull final String tooltip)
 Creates a new instance. More...
 
String getFaceName ()
 Returns the current face name. More...
 
Component getInputComponent ()
 Returns the input field component. More...
 
void setEnabled (final boolean enabled)
 
void setFaceName (@NotNull final String faceName)
 Sets the current face name. More...
 

Private Attributes

final FaceTreeChooseAction faceTreeChooseAction
 The associated FaceTreeChooseAction. More...
 
final JTextField textField = new JTextField()
 The JTextField that displays the face name. More...
 

Static Private Attributes

static final long serialVersionUID = 1L
 The serial version UID. More...
 

Detailed Description

A JPanel that allows the user to select a face name.

Author
Andreas Kirschbaum

Definition at line 41 of file FaceComponent.java.

Constructor & Destructor Documentation

◆ FaceComponent()

net.sf.gridarta.gui.utils.FaceComponent.FaceComponent ( @NotNull final String  faceName,
@NotNull final FaceObjects  faceObjects,
@NotNull final FaceObjectProviders  faceObjectProviders,
@NotNull final ImageIcon  noFaceSquareIcon,
@NotNull final ImageIcon  unknownSquareIcon,
@NotNull final String  tooltip 
)

Creates a new instance.

Parameters
faceNamethe initial face name
faceObjectsthe face objects to use
faceObjectProvidersthe face object providers for looking up faces
noFaceSquareIconthe image icon for no animations
unknownSquareIconthe image icon for undefined animations
tooltiptooltip to display on the fields.

Definition at line 70 of file FaceComponent.java.

References net.sf.gridarta.gui.utils.FaceTreeChooseAction.updateIconLabel().

+ Here is the call graph for this function:

Member Function Documentation

◆ getFaceName()

◆ getInputComponent()

Component net.sf.gridarta.gui.utils.FaceComponent.getInputComponent ( )

Returns the input field component.

Returns
the input field component

Definition at line 148 of file FaceComponent.java.

References net.sf.gridarta.gui.utils.FaceComponent.textField.

Referenced by net.sf.gridarta.gui.panel.gameobjectattributes.FaceTab< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.FaceTab().

+ Here is the caller graph for this function:

◆ setEnabled()

void net.sf.gridarta.gui.utils.FaceComponent.setEnabled ( final boolean  enabled)

◆ setFaceName()

void net.sf.gridarta.gui.utils.FaceComponent.setFaceName ( @NotNull final String  faceName)

Sets the current face name.

Parameters
faceNamethe face name

Definition at line 131 of file FaceComponent.java.

References net.sf.gridarta.gui.utils.FaceTreeChooseAction.updateIconLabel().

Referenced by net.sf.gridarta.gui.panel.gameobjectattributes.FaceTab< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.refresh().

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

Member Data Documentation

◆ faceTreeChooseAction

final FaceTreeChooseAction net.sf.gridarta.gui.utils.FaceComponent.faceTreeChooseAction
private

The associated FaceTreeChooseAction.

Definition at line 58 of file FaceComponent.java.

◆ serialVersionUID

final long net.sf.gridarta.gui.utils.FaceComponent.serialVersionUID = 1L
staticprivate

The serial version UID.

Definition at line 46 of file FaceComponent.java.

◆ textField

final JTextField net.sf.gridarta.gui.utils.FaceComponent.textField = new JTextField()
private

The JTextField that displays the face name.

Definition at line 52 of file FaceComponent.java.

Referenced by net.sf.gridarta.gui.utils.FaceComponent.getInputComponent().


The documentation for this class was generated from the following file: