org.openstreetmap.josm.gui.tagging.presets.items

Class ComboMultiSelect

java.lang.Object

org.openstreetmap.josm.gui.tagging.presets.TaggingPresetItem

org.openstreetmap.josm.gui.tagging.presets.items.KeyedItem

org.openstreetmap.josm.gui.tagging.presets.items.ComboMultiSelect

Direct Known Subclasses:

Combo, MultiSelect

public abstract class ComboMultiSelect
extends KeyedItem

Abstract superclass for combo box and multi-select list types.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	ComboMultiSelect.ConcatenatingJList Class that allows list values to be assigned and retrieved as a comma-delimited string (extracted from TaggingPreset)
static class	ComboMultiSelect.PresetListEntry Preset list entry.
private static class	ComboMultiSelect.Renderer

Nested classes/interfaces inherited from class org.openstreetmap.josm.gui.tagging.presets.items.KeyedItem

KeyedItem.MatchType, KeyedItem.Usage

Field Summary

Fields

Modifier and Type	Field and Description
protected javax.swing.JComponent	component
java.lang.String	default_ The default value for the item.
java.lang.String	delimiter The character that separates values.
java.lang.String	display_values A list of entries that is displayed to the user.
private boolean	initialized
protected java.util.Map<java.lang.String,ComboMultiSelect.PresetListEntry>	lhm
java.lang.String	locale_display_values The localized version of display_values.
java.lang.String	locale_short_descriptions The localized version of short_descriptions.
java.lang.String	locale_text The localized version of KeyedItem.text.
protected java.lang.Object	originalValue
private static ComboMultiSelect.Renderer	RENDERER
java.lang.String	short_descriptions A delimiter-separated list of texts to be displayed below each display_value.
protected KeyedItem.Usage	usage
java.lang.String	use_last_as_default whether the last value is used as default.
java.lang.String	values A list of entries.
java.lang.String	values_context The context used for translating values
java.lang.String	values_from To use instead of values if the list of values has to be obtained with a Java method of this form:
boolean	values_no_i18n Disabled internationalisation for value to avoid mistakes, see #11696
java.lang.String	values_searchable whether to use values for search via TaggingPresetSelector
boolean	values_sort Whether to sort the values, defaults to true.

Fields inherited from class org.openstreetmap.josm.gui.tagging.presets.items.KeyedItem

DIFFERENT, key, LAST_VALUES, match, PROP_FILL_DEFAULT, text, text_context

Constructor Summary

Constructors

Constructor and Description
ComboMultiSelect()

Method Summary

Modifier and Type	Method and Description
void	addCommands(java.util.List<Tag> changedTags) Adds the new tags to apply to selected OSM primitives when the preset holding this item is applied.
void	addListEntries(java.util.Collection<ComboMultiSelect.PresetListEntry> e) Adds a collection of preset list entries.
void	addListEntry(ComboMultiSelect.PresetListEntry e) Adds a preset list entry.
boolean	addToPanel(javax.swing.JPanel p, java.util.Collection<OsmPrimitive> sel, boolean presetInitiallyMatches) Called by TaggingPreset.createPanel(java.util.Collection<org.openstreetmap.josm.data.osm.OsmPrimitive>) during tagging preset panel creation.
protected abstract void	addToPanelAnchor(javax.swing.JPanel p, java.lang.String def, boolean presetInitiallyMatches)
KeyedItem.MatchType	getDefaultMatch() Returns the default match.
protected char	getDelChar()
protected java.lang.String	getDisplayIfNull()
java.util.Collection<java.lang.String>	getDisplayValues() Returns the values to display.
protected javax.swing.ListCellRenderer<ComboMultiSelect.PresetListEntry>	getListCellRenderer()
protected abstract java.lang.Object	getSelectedItem()
java.util.Collection<java.lang.String>	getValues() Returns the list of values.
private void	initListEntries()
private void	initListEntriesFromAttributes()
static java.lang.String[]	splitEscaped(char delimiter, java.lang.String s) allow escaped comma in comma separated list: "A\, B\, C,one\, two" --> ["A, B, C", "one, two"]

Methods inherited from class org.openstreetmap.josm.gui.tagging.presets.items.KeyedItem

determineBooleanUsage, determineTextUsage, getKeyTooltipText, isKeyRequired, matches, toString

Methods inherited from class org.openstreetmap.josm.gui.tagging.presets.TaggingPresetItem

fixPresetString, getLocaleText, getType, initAutoCompletionField, initAutoCompletionField, loadImageIcon, matches, parseInteger

Methods inherited from class java.lang.Object

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

Field Detail

RENDERER

private static final ComboMultiSelect.Renderer RENDERER

locale_text

public java.lang.String locale_text

The localized version of KeyedItem.text.

values

public java.lang.String values

A list of entries. The list has to be separated by commas (for the Combo box) or by the specified delimiter (for the MultiSelect). If a value contains the delimiter, the delimiter may be escaped with a backslash. If a value contains a backslash, it must also be escaped with a backslash.

values_from

public java.lang.String values_from

To use instead of values if the list of values has to be obtained with a Java method of this form:

public static String[] getValues();

The value must be: full.package.name.ClassName#methodName.

values_context

public java.lang.String values_context

The context used for translating values

values_no_i18n

public boolean values_no_i18n

Disabled internationalisation for value to avoid mistakes, see #11696

values_sort

public boolean values_sort

Whether to sort the values, defaults to true.

display_values

public java.lang.String display_values

A list of entries that is displayed to the user. Must be the same number and order of entries as values and editable must be false or not specified. For the delimiter character and escaping, see the remarks at values.

locale_display_values

public java.lang.String locale_display_values

The localized version of display_values.

short_descriptions

public java.lang.String short_descriptions

A delimiter-separated list of texts to be displayed below each display_value. (Only if it is not possible to describe the entry in 2-3 words.) Instead of comma separated list instead using values, display_values and short_descriptions, the following form is also supported:

<list_entry value="" display_value="" short_description="" icon="" icon_size="" />

locale_short_descriptions

public java.lang.String locale_short_descriptions

The localized version of short_descriptions.

default_

public java.lang.String default_

The default value for the item. If not specified, the current value of the key is chosen as default (if applicable).

delimiter

public java.lang.String delimiter

The character that separates values. In case of Combo the default is comma. In case of MultiSelect the default is semicolon and this will also be used to separate selected values in the tag.

use_last_as_default

public java.lang.String use_last_as_default

whether the last value is used as default. Using "force" enforces this behaviour also for already tagged objects. Default is "false".

values_searchable

public java.lang.String values_searchable

whether to use values for search via TaggingPresetSelector

component

protected javax.swing.JComponent component

lhm

protected final java.util.Map<java.lang.String,ComboMultiSelect.PresetListEntry> lhm

initialized

private boolean initialized

usage

protected KeyedItem.Usage usage

originalValue

protected java.lang.Object originalValue

Constructor Detail

ComboMultiSelect

public ComboMultiSelect()

Method Detail

splitEscaped

public static java.lang.String[] splitEscaped(char delimiter,
                                              java.lang.String s)

allow escaped comma in comma separated list: "A\, B\, C,one\, two" --> ["A, B, C", "one, two"]

Parameters:

delimiter - the delimiter, e.g. a comma. separates the entries and must be escaped within one entry

s - the string

Returns:

splitted items

getSelectedItem

protected abstract java.lang.Object getSelectedItem()

addToPanelAnchor

protected abstract void addToPanelAnchor(javax.swing.JPanel p,
                                         java.lang.String def,
                                         boolean presetInitiallyMatches)

getDelChar

protected char getDelChar()

getValues

public java.util.Collection<java.lang.String> getValues()

Description copied from class: KeyedItem

Returns the list of values.

Specified by:

getValues in class KeyedItem

Returns:

the list of values

getDisplayValues

public java.util.Collection<java.lang.String> getDisplayValues()

Returns the values to display.

Returns:

the values to display

addToPanel

public boolean addToPanel(javax.swing.JPanel p,
                          java.util.Collection<OsmPrimitive> sel,
                          boolean presetInitiallyMatches)

Description copied from class: TaggingPresetItem

Called by TaggingPreset.createPanel(java.util.Collection<org.openstreetmap.josm.data.osm.OsmPrimitive>) during tagging preset panel creation. All components defining this tagging preset item must be added to given panel.

Specified by:

addToPanel in class TaggingPresetItem

Parameters:

p - The panel where components must be added

sel - The related selected OSM primitives

presetInitiallyMatches - Whether this TaggingPreset already matched before applying, i.e. whether the map feature already existed on the primitive.

Returns:

true if this item adds semantic tagging elements, false otherwise.

initListEntries

private void initListEntries()

initListEntriesFromAttributes

private void initListEntriesFromAttributes()

getDisplayIfNull

protected java.lang.String getDisplayIfNull()

addCommands

public void addCommands(java.util.List<Tag> changedTags)

Description copied from class: TaggingPresetItem

Adds the new tags to apply to selected OSM primitives when the preset holding this item is applied.

Specified by:

addCommands in class TaggingPresetItem

Parameters:

changedTags - The list of changed tags to modify if needed

addListEntry

public void addListEntry(ComboMultiSelect.PresetListEntry e)

Adds a preset list entry.

Parameters:

e - list entry to add

addListEntries

public void addListEntries(java.util.Collection<ComboMultiSelect.PresetListEntry> e)

Adds a collection of preset list entries.

Parameters:

e - list entries to add

getListCellRenderer

protected javax.swing.ListCellRenderer<ComboMultiSelect.PresetListEntry> getListCellRenderer()

getDefaultMatch

public KeyedItem.MatchType getDefaultMatch()

Description copied from class: KeyedItem

Returns the default match.

Specified by:

getDefaultMatch in class KeyedItem

Returns:

the default match