Package net.sf.gridarta.gui.dialog.gameobjectattributes

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

java.lang.Object

net.sf.gridarta.gui.dialog.gameobjectattributes.DialogAttribute<G,A,R,ArchetypeAttributeString>

net.sf.gridarta.gui.dialog.gameobjectattributes.DialogAttributeString<G,A,R>

public class DialogAttributeString<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>
extends DialogAttribute<G,A,R,ArchetypeAttributeString>

Constructor Summary

Constructors

Constructor	Description
DialogAttributeString(@NotNull ArchetypeAttributeString ref, @NotNull javax.swing.text.JTextComponent input)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
void	appendSummary(@NotNull javax.swing.text.Document doc, @NotNull javax.swing.text.Style style)	Appends a summary line for this attribute to a Document.
@NotNull java.lang.String	getObjectText(G gameObject, @NotNull Archetype<G,A,R> archetype, @NotNull java.lang.String @NotNull [] newMsg, @NotNull ArchetypeType archetypeType)	Returns the attribute text for this attribute.

Methods inherited from class net.sf.gridarta.gui.dialog.gameobjectattributes.DialogAttribute

addLine, getRef

Methods inherited from class java.lang.Object

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

Constructor Detail

DialogAttributeString

public DialogAttributeString(@NotNull
                             @NotNull ArchetypeAttributeString ref,
                             @NotNull
                             @NotNull javax.swing.text.JTextComponent input)

Creates a new instance.

Parameters:

ref - reference to the attribute data

input - the input ui component for editing the value

Method Detail

getObjectText

@NotNull
public @NotNull java.lang.String getObjectText(@NotNull
                                               G gameObject,
                                               @NotNull
                                               @NotNull Archetype<G,A,R> archetype,
                                               @NotNull
                                               @NotNull java.lang.String @NotNull [] newMsg,
                                               @NotNull
                                               @NotNull ArchetypeType archetypeType)

Description copied from class: DialogAttribute

Returns the attribute text for this attribute. The returned string is inserted into the owner's game object text.

Specified by:

getObjectText in class DialogAttribute<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>,ArchetypeAttributeString>

Parameters:

gameObject - the owner

archetype - the owner's new archetype; it might differ from gameObject's current archetype

newMsg - the new "msg" value for the owner

archetypeType - the owner's archetype type

Returns:

the game object text or an empty string

appendSummary

public void appendSummary(@NotNull
                          @NotNull javax.swing.text.Document doc,
                          @NotNull
                          @NotNull javax.swing.text.Style style)

Description copied from class: DialogAttribute

Appends a summary line for this attribute to a Document.

Specified by:

appendSummary in class DialogAttribute<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>,ArchetypeAttributeString>

Parameters:

doc - the document to append to

style - the style for the new text