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

Class ComboMultiSelect.PresetListEntry

java.lang.Object

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

All Implemented Interfaces:

java.lang.Comparable<ComboMultiSelect.PresetListEntry>

Enclosing class:

ComboMultiSelect

public static class ComboMultiSelect.PresetListEntry
extends java.lang.Object
implements java.lang.Comparable<ComboMultiSelect.PresetListEntry>

Preset list entry.

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	display_value Value displayed to the user
java.lang.String	icon The location of icon file to display
java.lang.String	icon_size The size of displayed icon.
java.lang.String	locale_display_value The localized version of display_value.
java.lang.String	locale_short_description The localized version of short_description.
int	prefferedHeight Cached height (currently only for Combo) to speed up preset dialog initialization
int	prefferedWidth Cached width (currently only for Combo) to speed up preset dialog initialization
java.lang.String	short_description Text to be displayed below display_value.
java.lang.String	value Entry value
java.lang.String	value_context The context used for translating value
private java.io.File	zipIcons

Constructor Summary

Constructors

Constructor and Description
PresetListEntry() Constructs a new PresetListEntry, uninitialized.
PresetListEntry(java.lang.String value) Constructs a new PresetListEntry, initialized with a value.

Method Summary

Modifier and Type	Method and Description
int	compareTo(ComboMultiSelect.PresetListEntry o)
java.lang.String	getDisplayValue(boolean translated) Returns the value to display.
javax.swing.ImageIcon	getIcon() Returns the entry icon, if any.
java.lang.String	getListDisplay() Returns HTML formatted contents.
java.lang.String	getShortDescription(boolean translated) Returns the short description to display.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

value

public java.lang.String value

Entry value

value_context

public java.lang.String value_context

The context used for translating value

display_value

public java.lang.String display_value

Value displayed to the user

short_description

public java.lang.String short_description

Text to be displayed below display_value.

icon

public java.lang.String icon

The location of icon file to display

icon_size

public java.lang.String icon_size

The size of displayed icon. If not set, default is size from icon file

locale_display_value

public java.lang.String locale_display_value

The localized version of display_value.

locale_short_description

public java.lang.String locale_short_description

The localized version of short_description.

zipIcons

private final java.io.File zipIcons

prefferedWidth

public int prefferedWidth

Cached width (currently only for Combo) to speed up preset dialog initialization

prefferedHeight

public int prefferedHeight

Cached height (currently only for Combo) to speed up preset dialog initialization

Constructor Detail

PresetListEntry

public PresetListEntry()

Constructs a new PresetListEntry, uninitialized.

PresetListEntry

public PresetListEntry(java.lang.String value)

Constructs a new PresetListEntry, initialized with a value.

Parameters:

value - value

Method Detail

getListDisplay

public java.lang.String getListDisplay()

Returns HTML formatted contents.

Returns:

HTML formatted contents

getIcon

public javax.swing.ImageIcon getIcon()

Returns the entry icon, if any.

Returns:

the entry icon, or null

getDisplayValue

public java.lang.String getDisplayValue(boolean translated)

Returns the value to display.

Parameters:

translated - whether the text must be translated

Returns:

the value to display

getShortDescription

public java.lang.String getShortDescription(boolean translated)

Returns the short description to display.

Parameters:

translated - whether the text must be translated

Returns:

the short description to display

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

compareTo

public int compareTo(ComboMultiSelect.PresetListEntry o)

Specified by:

compareTo in interface java.lang.Comparable<ComboMultiSelect.PresetListEntry>