Gridarta Editor
DialogAttributeZSpell.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.JComboBox;
23 import javax.swing.text.Document;
24 import javax.swing.text.Style;
32 import org.jetbrains.annotations.NotNull;
33 
34 public class DialogAttributeZSpell<G extends GameObject<G, A, R>, A extends MapArchObject<A>, R extends Archetype<G, A, R>> extends DialogAttribute<G, A, R, ArchetypeAttributeZSpell> {
35 
39  @NotNull
40  private final JComboBox<?> input;
41 
46 
50  private final int undefinedSpellIndex;
51 
59  public DialogAttributeZSpell(@NotNull final ArchetypeAttributeZSpell ref, @NotNull final JComboBox<?> input, @NotNull final Spells<NumberSpell> numberSpells, final int undefinedSpellIndex) {
60  super(ref);
61  this.input = input;
62  this.numberSpells = numberSpells;
63  this.undefinedSpellIndex = undefinedSpellIndex;
64  }
65 
66  @NotNull
67  @Override
68  public String getObjectText(@NotNull final G gameObject, @NotNull final Archetype<G, A, R> archetype, @NotNull final String @NotNull [] newMsg, @NotNull final ArchetypeType archetypeType) {
69  final int index = input.getSelectedIndex();
70  final int attributeValue = index == 0 ? undefinedSpellIndex : numberSpells.getSpell(index - 1).getNumber(); // attribute value
71  final String archetypeAttributeName = getRef().getArchetypeAttributeName();
72  return archetype.getAttributeInt(archetypeAttributeName) == attributeValue ? "" : archetypeAttributeName + " " + attributeValue;
73  }
74 
75  @Override
76  public void appendSummary(@NotNull final Document doc, @NotNull final Style style) {
77  final Object selectedItem = input.getSelectedItem();
78  if (selectedItem == null) {
79  return;
80  }
81 
82  final String value = selectedItem.toString().trim();
83  if (value.isEmpty() || value.startsWith("<")) {
84  return;
85  }
86 
87  addLine(doc, style, "", " = " + value);
88  }
89 
90 }
net.sf.gridarta.gui.dialog.gameobjectattributes.DialogAttribute< G, A, R, ArchetypeAttributeZSpell >::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, ArchetypeAttributeZSpell >::getRef
T getRef()
Returns the attribute data.
Definition: DialogAttribute.java:68
net.sf.gridarta
Base package of all Gridarta classes.
net.sf
net.sf.gridarta.gui.dialog.gameobjectattributes.DialogAttributeZSpell.appendSummary
void appendSummary(@NotNull final Document doc, @NotNull final Style style)
Definition: DialogAttributeZSpell.java:76
net.sf.gridarta.gui.dialog.gameobjectattributes.DialogAttribute< G, A, R, ArchetypeAttributeZSpell >::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.model.gameobject
GameObjects are the objects based on Archetypes found on maps.
Definition: AbstractGameObject.java:20
net.sf.gridarta.gui.dialog.gameobjectattributes.DialogAttributeZSpell.getObjectText
String getObjectText(@NotNull final G gameObject, @NotNull final Archetype< G, A, R > archetype, @NotNull final String @NotNull[] newMsg, @NotNull final ArchetypeType archetypeType)
Definition: DialogAttributeZSpell.java:68
net
net.sf.gridarta.model.maparchobject.MapArchObject
Interface for MapArchObjects.
Definition: MapArchObject.java:40
net.sf.gridarta.model.spells.NumberSpell
Describes a numbered in-game spell.
Definition: NumberSpell.java:28
net.sf.gridarta.gui.dialog.gameobjectattributes.DialogAttributeZSpell
Definition: DialogAttributeZSpell.java:34
net.sf.gridarta.gui.dialog.gameobjectattributes.DialogAttributeZSpell.undefinedSpellIndex
final int undefinedSpellIndex
The index used for "no" spell.
Definition: DialogAttributeZSpell.java:50
net.sf.gridarta.model.spells
Definition: ArchetypeSetSpellLoader.java:20
net.sf.gridarta.gui.dialog.gameobjectattributes.DialogAttributeZSpell.input
final JComboBox<?> input
The input ui component for editing the value.
Definition: DialogAttributeZSpell.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.model.maparchobject
Definition: AbstractMapArchObject.java:20
net.sf.gridarta.gui.dialog.gameobjectattributes.DialogAttributeZSpell.numberSpells
final Spells< NumberSpell > numberSpells
The number spells to display.
Definition: DialogAttributeZSpell.java:45
net.sf.gridarta.model.spells.Spells
Common base class for spells and spell lists.
Definition: Spells.java:33
net.sf.gridarta.gui.dialog.gameobjectattributes.DialogAttributeZSpell.DialogAttributeZSpell
DialogAttributeZSpell(@NotNull final ArchetypeAttributeZSpell ref, @NotNull final JComboBox<?> input, @NotNull final Spells< NumberSpell > numberSpells, final int undefinedSpellIndex)
Creates a new instance.
Definition: DialogAttributeZSpell.java:59
net.sf.gridarta.model.archetypetype.ArchetypeAttributeZSpell
An ArchetypeAttribute for selecting an optional spell encoded as an integer attribute.
Definition: ArchetypeAttributeZSpell.java:30