Gridarta Editor
DialogAttributeTreasure.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.Document;
23 import javax.swing.text.JTextComponent;
24 import javax.swing.text.Style;
32 import org.jetbrains.annotations.NotNull;
33 
34 // a treasurelist attribute
35 
36 public class DialogAttributeTreasure<G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> extends DialogAttribute<G, A, R, ArchetypeAttributeTreasure> {
37 
41  @NotNull
42  private final JTextComponent input;
43 
47  @NotNull
48  private final TreasureTree treasureTree;
49 
56  public DialogAttributeTreasure(@NotNull final ArchetypeAttributeTreasure ref, @NotNull final JTextComponent input, @NotNull final TreasureTree treasureTree) {
57  super(ref);
58  this.input = input;
59  this.treasureTree = treasureTree;
60  }
61 
62  @NotNull
63  @Override
64  public String getObjectText(@NotNull final G gameObject, @NotNull final Archetype<G, A, R> archetype, @NotNull final String @NotNull [] newMsg, @NotNull final ArchetypeType archetypeType) throws InvalidAttributeException {
65  final String inline = input.getText().trim(); // input string
66  final boolean isNone = inline.equals(CFTreasureListTree.NONE_SYM) || inline.isEmpty();
67  final String archetypeAttributeName = getRef().getArchetypeAttributeName();
68  if (!isNone && treasureTree.get(inline) == null && !inline.equalsIgnoreCase(archetype.getAttributeString(archetypeAttributeName))) {
69  // The user has specified a WRONG treasurelist name, and it does not come
70  // from the default gameObject. -> Error and out.
71  throw new InvalidAttributeException("In attribute '" + getRef().getAttributeName() + "':\n" + "'" + inline + "' is not a known treasurelist name!");
72  }
73 
74  if (!inline.equalsIgnoreCase(archetype.getAttributeString(archetypeAttributeName)) && !(isNone && !archetype.hasAttribute(archetypeAttributeName))) {
75  return archetypeAttributeName + " " + (isNone ? "none" : inline);
76  }
77 
78  return "";
79  }
80 
81  @Override
82  public void appendSummary(@NotNull final Document doc, @NotNull final Style style) {
83  final String text = input.getText();
84  if (text == null) {
85  return;
86  }
87 
88  final String value = text.trim();
89  if (value.isEmpty() || value.equals(CFTreasureListTree.NONE_SYM)) {
90  return;
91  }
92 
93  addLine(doc, style, "", " = " + value);
94  }
95 
96 }
net.sf.gridarta.gui.dialog.gameobjectattributes.DialogAttribute< G, A, R, ArchetypeAttributeTreasure >::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< G, A, R, ArchetypeAttributeTreasure >::getRef
T getRef()
Returns the attribute data.
Definition: DialogAttribute.java:68
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.gridarta.gui.dialog.gameobjectattributes.DialogAttributeTreasure.appendSummary
void appendSummary(@NotNull final Document doc, @NotNull final Style style)
Definition: DialogAttributeTreasure.java:82
net.sf.gridarta.model.treasurelist.TreasureTree.get
TreasureTreeNode get(@NotNull final String name)
Returns a treasure list by name.
Definition: TreasureTree.java:60
net.sf
net.sf.gridarta.gui.dialog.gameobjectattributes.DialogAttribute< G, A, R, ArchetypeAttributeTreasure >::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.DialogAttributeTreasure.input
final JTextComponent input
The input ui component for editing the value.
Definition: DialogAttributeTreasure.java:42
net.sf.gridarta.gui
Graphical User Interface of Gridarta.
net.sf.gridarta.gui.dialog.gameobjectattributes.DialogAttributeTreasure
Definition: DialogAttributeTreasure.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.model.gameobject
GameObjects are the objects based on Archetypes found on maps.
Definition: AbstractGameObject.java:20
net
net.sf.gridarta.gui.dialog.gameobjectattributes.DialogAttributeTreasure.getObjectText
String getObjectText(@NotNull final G gameObject, @NotNull final Archetype< G, A, R > archetype, @NotNull final String @NotNull[] newMsg, @NotNull final ArchetypeType archetypeType)
Definition: DialogAttributeTreasure.java:64
net.sf.gridarta.model.treasurelist.TreasureTree
Stores all defined treasure lists.
Definition: TreasureTree.java:32
net.sf.gridarta.model.maparchobject.MapArchObject
Interface for MapArchObjects.
Definition: MapArchObject.java:40
net.sf.gridarta.model.archetypetype.ArchetypeAttributeTreasure
An ArchetypeAttribute representing a treasurelist.
Definition: ArchetypeAttributeTreasure.java:29
net.sf.gridarta.gui.treasurelist.CFTreasureListTree.NONE_SYM
static final String NONE_SYM
The string displayed in attribute dialog for "none".
Definition: CFTreasureListTree.java:67
net.sf.gridarta.model
net.sf.gridarta.model.archetype.Archetype
Reflects an Archetype.
Definition: Archetype.java:41
net.sf.gridarta.gui.dialog.gameobjectattributes.DialogAttributeTreasure.treasureTree
final TreasureTree treasureTree
The TreasureTree to use.
Definition: DialogAttributeTreasure.java:48
net.sf.gridarta.model.archetypetype.ArchetypeType
Contains the data of one Gridarta Object-Type.
Definition: ArchetypeType.java:35
net.sf.gridarta.model.maparchobject
Definition: AbstractMapArchObject.java:20
net.sf.gridarta.gui.treasurelist
Definition: CFTreasureListTree.java:20
net.sf.gridarta.model.treasurelist
Definition: ArchTreasureObj.java:20
net.sf.gridarta.gui.dialog.gameobjectattributes.DialogAttributeTreasure.DialogAttributeTreasure
DialogAttributeTreasure(@NotNull final ArchetypeAttributeTreasure ref, @NotNull final JTextComponent input, @NotNull final TreasureTree treasureTree)
Creates a new instance.
Definition: DialogAttributeTreasure.java:56
net.sf.gridarta.gui.treasurelist.CFTreasureListTree
The CFTreasureListTree class fully manages treasurelists.
Definition: CFTreasureListTree.java:61