Gridarta Editor
DialogAttribute.java
Go to the documentation of this file.
1 /*
2  * Gridarta MMORPG map editor for Crossfire, Daimonin and similar games.
3  * Copyright (C) 2000-2023 The Gridarta Developers.
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 2 of the License, or
8  * (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License along
16  * with this program; if not, write to the Free Software Foundation, Inc.,
17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18  */
19 
20 package net.sf.gridarta.gui.dialog.gameobjectattributes;
21 
22 import javax.swing.text.AttributeSet;
23 import javax.swing.text.BadLocationException;
24 import javax.swing.text.Document;
25 import javax.swing.text.Style;
31 import org.apache.log4j.Category;
32 import org.apache.log4j.Logger;
33 import org.jetbrains.annotations.NotNull;
34 
41 public abstract class DialogAttribute<G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>, T extends ArchetypeAttribute> {
42 
46  @NotNull
47  private static final Category LOG = Logger.getLogger(DialogAttribute.class);
48 
52  @NotNull
53  private final T ref;
54 
59  protected DialogAttribute(@NotNull final T ref) {
60  this.ref = ref;
61  }
62 
67  @NotNull
68  public T getRef() {
69  return ref;
70  }
71 
83  @NotNull
84  public abstract String getObjectText(@NotNull G gameObject, @NotNull Archetype<G, A, R> archetype, @NotNull String @NotNull [] newMsg, @NotNull ArchetypeType archetypeType) throws InvalidAttributeException;
85 
91  public abstract void appendSummary(@NotNull Document doc, @NotNull Style style);
92 
101  protected void addLine(@NotNull final Document doc, @NotNull final AttributeSet style, @NotNull final String prefix, @NotNull final String postfix) {
102  try {
103  doc.insertString(doc.getLength(), prefix + ref.getAttributeName() + postfix + "\n", style);
104  } catch (final BadLocationException e) {
105  LOG.error("toggleSummary: Bad Location in Document!", e);
106  }
107  }
108 
109 }
net.sf.gridarta.gui.dialog.gameobjectattributes.DialogAttribute.ref
final T ref
Reference to the attribute data.
Definition: DialogAttribute.java:53
net.sf.gridarta.model.archetypetype
Defines types of GameObjects with corresponding attributes.
Definition: AbstractArchetypeAttributeInvSpell.java:20
net.sf.gridarta.gui.dialog.gameobjectattributes.DialogAttribute.getRef
T getRef()
Returns the attribute data.
Definition: DialogAttribute.java:68
net.sf.gridarta.gui.dialog.gameobjectattributes.DialogAttribute.DialogAttribute
DialogAttribute(@NotNull final T ref)
Creates a new instance.
Definition: DialogAttribute.java:59
net.sf.gridarta
Base package of all Gridarta classes.
net.sf.gridarta.gui.dialog.gameobjectattributes.InvalidAttributeException
Indicates that an attribute cannot be encoded.
Definition: InvalidAttributeException.java:29
net.sf
net.sf.gridarta.gui.dialog.gameobjectattributes.DialogAttribute.addLine
void addLine(@NotNull final Document doc, @NotNull final AttributeSet style, @NotNull final String prefix, @NotNull final String postfix)
Appends a line to a Document.
Definition: DialogAttribute.java:101
net.sf.gridarta.model.archetype
Definition: AbstractArchetype.java:20
net.sf.gridarta.model.gameobject.GameObject
Reflects a game object (object on a map).
Definition: GameObject.java:36
net.sf.gridarta.gui.dialog.gameobjectattributes.DialogAttribute
A single Attribute, combining an ArchetypeAttribute with its input component(s).
Definition: DialogAttribute.java:41
net.sf.gridarta.gui.dialog.gameobjectattributes.DialogAttribute.appendSummary
abstract void appendSummary(@NotNull Document doc, @NotNull Style style)
Appends a summary line for this attribute to a Document.
net.sf.gridarta.model.gameobject
GameObjects are the objects based on Archetypes found on maps.
Definition: AbstractGameObject.java:20
net
net.sf.gridarta.model.archetypetype.ArchetypeAttribute
This Class contains the data of one archetype attribute.
Definition: ArchetypeAttribute.java:28
net.sf.gridarta.model.maparchobject.MapArchObject
Interface for MapArchObjects.
Definition: MapArchObject.java:40
net.sf.gridarta.model
net.sf.gridarta.model.archetype.Archetype
Reflects an Archetype.
Definition: Archetype.java:41
net.sf.gridarta.model.archetypetype.ArchetypeType
Contains the data of one Gridarta Object-Type.
Definition: ArchetypeType.java:35
net.sf.gridarta.gui.dialog.gameobjectattributes.DialogAttribute.LOG
static final Category LOG
The Logger for printing log messages.
Definition: DialogAttribute.java:47
net.sf.gridarta.model.maparchobject
Definition: AbstractMapArchObject.java:20
net.sf.gridarta.gui.dialog.gameobjectattributes.DialogAttribute.getObjectText
abstract String getObjectText(@NotNull G gameObject, @NotNull Archetype< G, A, R > archetype, @NotNull String @NotNull[] newMsg, @NotNull ArchetypeType archetypeType)
Returns the attribute text for this attribute.