A model for the 'encoding' combo box. This combobox model presents a selection for all
available string encodings.
AVAILABLE_ENCODINGS
public static final String AVAILABLE_ENCODINGS
The property that defines which encodings are available in the export dialogs.
AVAILABLE_ENCODINGS_ALL
public static final String AVAILABLE_ENCODINGS_ALL
The encodings available properties value for all properties.
AVAILABLE_ENCODINGS_FILE
public static final String AVAILABLE_ENCODINGS_FILE
The encodings available properties value for properties defined in the properties
file.
AVAILABLE_ENCODINGS_NONE
public static final String AVAILABLE_ENCODINGS_NONE
The encodings available properties value for no properties defined. The encoding
selection will be disabled.
ENCODINGS_DEFINITION_FILE
public static final String ENCODINGS_DEFINITION_FILE
The name of the properties file used to define the available encodings. The property
points to a resources in the classpath, not to a real file!
ENCODINGS_DEFINITION_FILE_DEFAULT
public static final String ENCODINGS_DEFINITION_FILE_DEFAULT
The default name for the encoding properties file. This property defaults to
"/org/jfree/report/jfreereport-encodings.properties".
addEncoding
public boolean addEncoding(String name,
String description)
Adds an encoding.
name
- the name.description
- the description.
true
if the encoding is valid and added to the model,
false
otherwise.
addEncodingUnchecked
public void addEncodingUnchecked(String name,
String description)
Adds an encoding to the model without checking its validity.
name
- the name.description
- the description.
addListDataListener
public void addListDataListener(ListDataListener l)
Adds a listener to the list that's notified each time a change to the data model
occurs.
l
- the ListDataListener
to be added
ensureEncodingAvailable
public void ensureEncodingAvailable(String encoding)
Make sure, that this encoding is defined and selectable in the combobox model.
encoding
- the encoding that should be verified.
fireContentsChanged
protected void fireContentsChanged()
Notifies all registered listeners that the content of the model has changed.
fireContentsChanged
protected void fireContentsChanged(int start,
int length)
Notifies all registered listeners that the content of the model has changed.
getAvailableEncodings
public static String getAvailableEncodings()
Defines the loader settings for the available encodings shown to the user. The
property defaults to AVAILABLE_ENCODINGS_ALL.
- either AVAILABLE_ENCODINGS_ALL, AVAILABLE_ENCODINGS_FILE or
AVAILABLE_ENCODINGS_NONE.
getDescription
public String getDescription(int index)
Returns a description.
getElementAt
public Object getElementAt(int index)
Returns the value at the specified index.
index
- the requested index
getEncoding
public String getEncoding(int index)
Returns an encoding.
getEncodingsDefinitionFile
public static String getEncodingsDefinitionFile()
Defines the loader settings for the available encodings shown to the user. The
property defaults to AVAILABLE_ENCODINGS_ALL.
- either AVAILABLE_ENCODINGS_ALL, AVAILABLE_ENCODINGS_FILE or
AVAILABLE_ENCODINGS_NONE.
getSelectedItem
public Object getSelectedItem()
Returns the selected item.
- The selected item or
null
if there is no selection
getSize
public int getSize()
Returns the length of the list.
indexOf
public int indexOf(String encoding)
Returns the index of an encoding.
encoding
- the encoding (name).
removeListDataListener
public void removeListDataListener(ListDataListener l)
Removes a listener from the list that's notified each time a change to the data model
occurs.
l
- the ListDataListener
to be removed
setSelectedIndex
public void setSelectedIndex(int index)
Defines the selected index for this encoding model.
index
- the selected index or -1 to clear the selection.
setSelectedItem
public void setSelectedItem(Object anItem)
Set the selected item. The implementation of this method should notify all
registered ListDataListener
s that the contents have changed.
anItem
- the list object to select or null
to clear the selection
sort
public void sort()
Sorts the encodings. Keep the selected object ...