net.sf.gridarta.gui.panel.gameobjectattributes

Class AbstractGameObjectAttributesTab<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

java.lang.Object

net.sf.gridarta.gui.panel.gameobjectattributes.AbstractGameObjectAttributesTab<G,A,R>

All Implemented Interfaces:

GameObjectAttributesTab<G,A,R>

Direct Known Subclasses:

ArchTab, EventsTab, FaceTab, MsgTextTab, TextEditorTab

public abstract class AbstractGameObjectAttributesTab<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>
extends java.lang.Object
implements GameObjectAttributesTab<G,A,R>

Base class for GameObjectAttributesTab implementations.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractGameObjectAttributesTab(GameObjectAttributesModel<G,A,R> gameObjectAttributesModel) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
protected void	addAutoApply(java.awt.Component component) Registers a component that auto-applies when the focus is lost.
void	addGameObjectAttributesTabListener(GameObjectAttributesTabListener<G,A,R> listener) Adds a listener.
void	apply() Applies the current settings.
protected abstract void	apply(G gameObject) Applies settings to the given game object.
protected GameObject<G,A,R>	getSelectedGameObject() Returns the currently selected GameObject.
Severity	getTabSeverity() Returns the tab severity.
protected abstract void	refresh(G gameObject) Refreshes the display.
void	removeGameObjectAttributesTabListener(GameObjectAttributesTabListener<G,A,R> listener) Removes a listener.
protected void	setTabSeverity(Severity tabSeverity) Sets the tab severity.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.gridarta.gui.panel.gameobjectattributes.GameObjectAttributesTab

activate, canApply, getPanel

Constructor Detail

AbstractGameObjectAttributesTab

protected AbstractGameObjectAttributesTab(@NotNull
                                          GameObjectAttributesModel<G,A,R> gameObjectAttributesModel)

Creates a new instance.

Parameters:

gameObjectAttributesModel - the model to track

Method Detail

setTabSeverity

protected void setTabSeverity(@NotNull
                              Severity tabSeverity)

Sets the tab severity.

Parameters:

tabSeverity - the tab severity

addGameObjectAttributesTabListener

public void addGameObjectAttributesTabListener(@NotNull
                                               GameObjectAttributesTabListener<G,A,R> listener)

Adds a listener.

Specified by:

addGameObjectAttributesTabListener in interface GameObjectAttributesTab<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

Parameters:

listener - the listener

removeGameObjectAttributesTabListener

public void removeGameObjectAttributesTabListener(@NotNull
                                                  GameObjectAttributesTabListener<G,A,R> listener)

Removes a listener.

Specified by:

removeGameObjectAttributesTabListener in interface GameObjectAttributesTab<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

Parameters:

listener - the listener

getTabSeverity

@NotNull
public Severity getTabSeverity()

Returns the tab severity.

Specified by:

getTabSeverity in interface GameObjectAttributesTab<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

Returns:

the tab severity

apply

public void apply()

Applies the current settings. It will be run within a map transaction for the current game object. This function will not be called unless GameObjectAttributesTab.canApply() returns true.

Specified by:

apply in interface GameObjectAttributesTab<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

refresh

protected abstract void refresh(@Nullable
                                G gameObject)

Refreshes the display.

Parameters:

gameObject - the game object to set the contents from

apply

protected abstract void apply(@NotNull
                              G gameObject)

Applies settings to the given game object.

Parameters:

gameObject - the game object to set the contents of

addAutoApply

protected void addAutoApply(@NotNull
                            java.awt.Component component)

Registers a component that auto-applies when the focus is lost.

Parameters:

component - the component

getSelectedGameObject

@Nullable
protected GameObject<G,A,R> getSelectedGameObject()

Returns the currently selected GameObject.

Returns:

the currently selected game object or null