TaggingPreset (JOSM)

java.lang.Object
- javax.swing.AbstractAction
- - org.openstreetmap.josm.gui.tagging.presets.TaggingPreset

All Implemented Interfaces:

ActionListener, Serializable, Cloneable, EventListener, Action, MapView.LayerChangeListener, Predicate<OsmPrimitive>

Direct Known Subclasses:

TaggingPresetMenu, TaggingPresetSeparator
```
public class TaggingPreset
extends AbstractAction
implements MapView.LayerChangeListener, Predicate<OsmPrimitive>
```
This class read encapsulate one tagging preset. A class method can read in all predefined presets, either shipped with JOSM or that are in the config directory. It is also able to construct dialogs out of preset definitions.

Since:

294

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`private static class`	`TaggingPreset.PresetDialog`
`private static class`	`TaggingPreset.PresetPanel`
`class`	`TaggingPreset.ToolbarButtonAction` Action that adds or removes the button on main toolbar

Field Summary

Fields
Modifier and Type	Field and Description
`List<TaggingPresetItem>`	`data`
`static int`	`DIALOG_ANSWER_APPLY`
`static int`	`DIALOG_ANSWER_CANCEL`
`static int`	`DIALOG_ANSWER_NEW_RELATION`
`TaggingPresetMenu`	`group`
`String`	`iconName`
`String`	`locale_name`
`String`	`name`
`String`	`name_context`
`TemplateEntry`	`nameTemplate`
`SearchCompiler.Match`	`nameTemplateFilter`
`static String`	`OPTIONAL_TOOLTIP_TEXT`
`private boolean`	`originalSelectionEmpty` True whenever the original selection given into createSelection was empty
`static String`	`PRESET_ICON_ERROR_MSG_PREFIX` Prefix of preset icon loading failure error message
`boolean`	`preset_name_label`
`Roles`	`roles`
`Set<TaggingPresetType>`	`types` The types as preparsed collection.

Fields inherited from class javax.swing.AbstractAction
changeSupport, enabled

Fields inherited from interface javax.swing.Action
ACCELERATOR_KEY, ACTION_COMMAND_KEY, DEFAULT, DISPLAYED_MNEMONIC_INDEX_KEY, LARGE_ICON_KEY, LONG_DESCRIPTION, MNEMONIC_KEY, NAME, SELECTED_KEY, SHORT_DESCRIPTION, SMALL_ICON

Constructor Summary

Constructors
Constructor and Description

TaggingPreset()
Create an empty tagging preset.

Constructors
Constructor and Description
`TaggingPreset()` Create an empty tagging preset.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`actionPerformed(ActionEvent e)`
`void`	`activeLayerChange(Layer oldLayer, Layer newLayer)` Notifies this listener that the active layer has changed.
`static Command`	`createCommand(Collection<OsmPrimitive> sel, List<Tag> changedTags)`
`TaggingPreset.PresetPanel`	`createPanel(Collection<OsmPrimitive> selected)`
`Collection<OsmPrimitive>`	`createSelection(Collection<OsmPrimitive> participants)` Removes all unsuitable OsmPrimitives from the given list
`boolean`	`evaluate(OsmPrimitive p)` Determines whether this preset matches the given primitive, i.e., whether the `type matches` and the `tags match`.
`List<Tag>`	`getChangedTags()`
`ImageIcon`	`getIcon()` Returns the preset icon.
`String`	`getLocaleName()`
`String`	`getName()` Returns the translated name of this preset, prefixed with the group names it belongs to.
`String`	`getRawName()` Returns the non translated name of this preset, prefixed with the (non translated) group names it belongs to.
`String`	`getToolbarString()`
`boolean`	`isShowable()` Determines whether a dialog can be shown for this preset, i.e., at least one tag can/must be set by the user.
`void`	`layerAdded(Layer newLayer)` Notifies this listener that a layer has been added.
`void`	`layerRemoved(Layer oldLayer)` Notifies this listener that a layer has been removed.
`boolean`	`matches(Collection<TaggingPresetType> t, Map<String,String> tags, boolean onlyShowable)` Determines whether this preset matches the parameters.
`void`	`setDisplayName()` Change the display name without changing the toolbar value.
`void`	`setIcon(String iconName)` Called from the XML parser to set the icon.
`void`	`setName_template_filter(String filter)`
`void`	`setName_template(String pattern)`
`void`	`setType(String types)` Called from the XML parser to set the types this preset affects.
`int`	`showDialog(Collection<OsmPrimitive> sel, boolean showNewRelation)`
`String`	`suggestRoleForOsmPrimitive(OsmPrimitive osm)`
`private boolean`	`supportsRelation()`
`String`	`toString()`
`boolean`	`typeMatches(Collection<TaggingPresetType> t)`
`protected void`	`updateEnabledState()`

Methods inherited from class javax.swing.AbstractAction
addPropertyChangeListener, clone, firePropertyChange, getKeys, getPropertyChangeListeners, getValue, isEnabled, putValue, removePropertyChangeListener, setEnabled

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - DIALOG_ANSWER_APPLY
```
public static final int DIALOG_ANSWER_APPLY
```
    See Also:
    
    Constant Field Values
  - DIALOG_ANSWER_NEW_RELATION
```
public static final int DIALOG_ANSWER_NEW_RELATION
```
    See Also:
    
    Constant Field Values
  - DIALOG_ANSWER_CANCEL
```
public static final int DIALOG_ANSWER_CANCEL
```
    See Also:
    
    Constant Field Values
  - OPTIONAL_TOOLTIP_TEXT
```
public static final String OPTIONAL_TOOLTIP_TEXT
```
    See Also:
    
    Constant Field Values
  - PRESET_ICON_ERROR_MSG_PREFIX
```
public static final String PRESET_ICON_ERROR_MSG_PREFIX
```
    Prefix of preset icon loading failure error message
    
    See Also:
    
    Constant Field Values
  - group
```
public TaggingPresetMenu group
```
  - name
```
public String name
```
  - iconName
```
public String iconName
```
  - name_context
```
public String name_context
```
  - locale_name
```
public String locale_name
```
  - preset_name_label
```
public boolean preset_name_label
```
  - types
```
public Set<TaggingPresetType> types
```
    The types as preparsed collection.
  - data
```
public transient List<TaggingPresetItem> data
```
  - roles
```
public transient Roles roles
```
  - nameTemplate
```
public transient TemplateEntry nameTemplate
```
  - nameTemplateFilter
```
public transient SearchCompiler.Match nameTemplateFilter
```
  - originalSelectionEmpty
```
private boolean originalSelectionEmpty
```
    True whenever the original selection given into createSelection was empty
- Constructor Detail
  - TaggingPreset
```
public TaggingPreset()
```
    Create an empty tagging preset. This will not have any items and will be an empty string as text. createPanel will return null. Use this as default item for "do not select anything".
- Method Detail
  - setDisplayName
```
public void setDisplayName()
```
    Change the display name without changing the toolbar value.
  - getLocaleName
```
public String getLocaleName()
```
  - getName
```
public String getName()
```
    Returns the translated name of this preset, prefixed with the group names it belongs to.
    
    Returns:
    
    the translated name of this preset, prefixed with the group names it belongs to
  - getRawName
```
public String getRawName()
```
    Returns the non translated name of this preset, prefixed with the (non translated) group names it belongs to.
    
    Returns:
    
    the non translated name of this preset, prefixed with the (non translated) group names it belongs to
  - getIcon
```
public final ImageIcon getIcon()
```
    Returns the preset icon.
    
    Returns:
    
    The preset icon, or null if none defined
    
    Since:
    
    6403
  - setIcon
```
public void setIcon(String iconName)
```
    Called from the XML parser to set the icon. The loading task is performed in the background in order to speedup startup.
    
    Parameters:
    
    iconName - icon name
  - setType
```
public void setType(String types)
             throws SAXException
```
    Called from the XML parser to set the types this preset affects.
    
    Parameters:
    
    types - comma-separated primitive types ("node", "way", "relation" or "closedway")
    
    Throws:
    
    SAXException - if any SAX error occurs
    
    See Also:
    
    TaggingPresetType.fromString(java.lang.String)
  - setName_template
```
public void setName_template(String pattern)
                      throws SAXException
```
    Throws:
    
    SAXException
  - setName_template_filter
```
public void setName_template_filter(String filter)
                             throws SAXException
```
    Throws:
    
    SAXException
  - createPanel
```
public TaggingPreset.PresetPanel createPanel(Collection<OsmPrimitive> selected)
```
  - isShowable
```
public boolean isShowable()
```
    Determines whether a dialog can be shown for this preset, i.e., at least one tag can/must be set by the user.
    
    Returns:
    
    true if a dialog can be shown for this preset
  - suggestRoleForOsmPrimitive
```
public String suggestRoleForOsmPrimitive(OsmPrimitive osm)
```
  - actionPerformed
```
public void actionPerformed(ActionEvent e)
```
    Specified by:
    
    actionPerformed in interface ActionListener
  - showDialog
```
public int showDialog(Collection<OsmPrimitive> sel,
                      boolean showNewRelation)
```
  - createSelection
```
public Collection<OsmPrimitive> createSelection(Collection<OsmPrimitive> participants)
```
    Removes all unsuitable OsmPrimitives from the given list
    
    Parameters:
    
    participants - List of possible OsmPrimitives to tag
    
    Returns:
    
    Cleaned list with suitable OsmPrimitives only
  - getChangedTags
```
public List<Tag> getChangedTags()
```
  - createCommand
```
public static Command createCommand(Collection<OsmPrimitive> sel,
                                    List<Tag> changedTags)
```
  - supportsRelation
```
private boolean supportsRelation()
```
  - updateEnabledState
```
protected final void updateEnabledState()
```
  - activeLayerChange
```
public void activeLayerChange(Layer oldLayer,
                              Layer newLayer)
```
    Description copied from interface: MapView.LayerChangeListener
    
    Notifies this listener that the active layer has changed.
    
    Specified by:
    
    activeLayerChange in interface MapView.LayerChangeListener
    
    Parameters:
    
    oldLayer - The previous active layer
    
    newLayer - The new activer layer
  - layerAdded
```
public void layerAdded(Layer newLayer)
```
    Description copied from interface: MapView.LayerChangeListener
    
    Notifies this listener that a layer has been added.
    
    Specified by:
    
    layerAdded in interface MapView.LayerChangeListener
    
    Parameters:
    
    newLayer - The new added layer
  - layerRemoved
```
public void layerRemoved(Layer oldLayer)
```
    Description copied from interface: MapView.LayerChangeListener
    
    Notifies this listener that a layer has been removed.
    
    Specified by:
    
    layerRemoved in interface MapView.LayerChangeListener
    
    Parameters:
    
    oldLayer - The old removed layer
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - typeMatches
```
public boolean typeMatches(Collection<TaggingPresetType> t)
```
  - evaluate
```
public boolean evaluate(OsmPrimitive p)
```
    Determines whether this preset matches the given primitive, i.e., whether the type matches and the tags match.
    
    Specified by:
    
    evaluate in interface Predicate<OsmPrimitive>
    
    Parameters:
    
    p - the primitive
    
    Returns:
    
    true if this preset matches the primitive
  - matches
```
public boolean matches(Collection<TaggingPresetType> t,
                       Map<String,String> tags,
                       boolean onlyShowable)
```
    Determines whether this preset matches the parameters.
    
    Parameters:
    
    t - the preset types to include, see typeMatches(Collection)
    
    tags - the tags to perform matching on, see TaggingPresetItem.matches(Map)
    
    onlyShowable - whether the preset must be showable
    
    Returns:
    
    true if this preset matches the parameters.
  - getToolbarString
```
public String getToolbarString()
```

Class TaggingPreset

Nested Class Summary

Field Summary

Fields inherited from class javax.swing.AbstractAction

Fields inherited from interface javax.swing.Action

Constructor Summary

Method Summary

Methods inherited from class javax.swing.AbstractAction

Methods inherited from class java.lang.Object

Field Detail

DIALOG_ANSWER_APPLY

DIALOG_ANSWER_NEW_RELATION

DIALOG_ANSWER_CANCEL

OPTIONAL_TOOLTIP_TEXT

PRESET_ICON_ERROR_MSG_PREFIX

group

name

iconName

name_context

locale_name

preset_name_label

types

data

roles

nameTemplate

nameTemplateFilter

originalSelectionEmpty

Constructor Detail

TaggingPreset

Method Detail

setDisplayName

getLocaleName

getName

getRawName

getIcon

setIcon

setType

setName_template

setName_template_filter

createPanel

isShowable

suggestRoleForOsmPrimitive

actionPerformed

showDialog

createSelection

getChangedTags

createCommand

supportsRelation

updateEnabledState

activeLayerChange

layerAdded

layerRemoved

toString

typeMatches

evaluate

matches

getToolbarString