- All Implemented Interfaces:
Serializable,ListModel<String>,MutableListModel<String>
A named history list
One history list can be used by several history text
fields. Note that the list model implementation is incomplete; no events
are fired when the history model changes.
The max size of the history is defined globally via setDefaultMax(),
see jEdit.java for instance.
It may be locally overriden by calling setMax() on a HistoryModel instance.
- Version:
- $Id: HistoryModel.java 24427 2016-06-22 22:29:03Z daleanson $
- Author:
- Slava Pestov, Eric Le Lay
- See Also:
-
Field Summary
Fields inherited from class javax.swing.AbstractListModel
listenerList -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidAdds an item to the end of this history list, trimming the list to the maximum number of items if necessary.static intGets the default size of all HistoryModels.static intGets the default maximum size (in characters) for all history models.getItem(int index) Returns an item from the history list.intgetMax()intstatic HistoryModelReturns a named model.getName()Returns the name of this history list.voidinsertElementAt(String obj, int index) static voidvoidbooleanremoveElement(Object obj) static voidstatic voidsetDefaultMax(int max) Sets the default size of all HistoryModels.static voidsetDefaultMaxSize(int newMax) Sets the default max size (in characters) for all history models.voidsetMax(int max) sets the maximum size of this historyvoidsetMaxSize(int max) Sets the maximum size (in characters) for this history modelstatic voidsetSaver(HistoryModelSaver saver) Methods inherited from class javax.swing.DefaultListModel
add, addAll, addAll, addElement, capacity, clear, contains, copyInto, elementAt, elements, ensureCapacity, firstElement, get, getElementAt, getSize, indexOf, indexOf, isEmpty, lastElement, lastIndexOf, lastIndexOf, remove, removeElementAt, removeRange, set, setElementAt, setSize, size, toArray, toString, trimToSizeMethods inherited from class javax.swing.AbstractListModel
addListDataListener, fireContentsChanged, fireIntervalAdded, fireIntervalRemoved, getListDataListeners, getListeners, removeListDataListenerMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface javax.swing.ListModel
addListDataListener, getElementAt, getSize, removeListDataListener
-
Constructor Details
-
HistoryModel
Creates a new history list. Calling this is normally not necessary.
-
-
Method Details
-
addItem
Adds an item to the end of this history list, trimming the list to the maximum number of items if necessary.- Parameters:
text- The item
-
insertElementAt
- Specified by:
insertElementAtin interfaceMutableListModel<String>- Overrides:
insertElementAtin classDefaultListModel<String>
-
getItem
Returns an item from the history list.- Parameters:
index- The index
-
removeElement
- Specified by:
removeElementin interfaceMutableListModel<String>- Overrides:
removeElementin classDefaultListModel<String>
-
removeAllElements
public void removeAllElements()- Overrides:
removeAllElementsin classDefaultListModel<String>
-
getName
Returns the name of this history list. This can be passed to the HistoryTextField constructor. -
getModel
Returns a named model. If the specified model does not already exist, it will be created.- Parameters:
name- The model name
-
loadHistory
public static void loadHistory() -
saveHistory
public static void saveHistory() -
setMax
public void setMax(int max) sets the maximum size of this history- Parameters:
max- the new maximum size of this history of -1 to restore default
-
getMax
public int getMax()- Returns:
- maximum size of this history or -1 is it's the default size
-
setMaxSize
public void setMaxSize(int max) Sets the maximum size (in characters) for this history model- Parameters:
max- the new maximum size for the history model, or -1 to restore the default- Since:
- jEdit 4.5pre1
-
getMaxSize
public int getMaxSize()- Returns:
- the maximum size (in characters) for this history model, or -1 for the default
- Since:
- jEdit 4.5pre1
-
setDefaultMax
public static void setDefaultMax(int max) Sets the default size of all HistoryModels. Affects the VFS path history, the hypersearch history, etc.. To change the max size of one history, call setMax() instead. -
getDefaultMax
public static int getDefaultMax()Gets the default size of all HistoryModels.- Returns:
- default size limit for HistoryModels
-
setDefaultMaxSize
public static void setDefaultMaxSize(int newMax) Sets the default max size (in characters) for all history models. To change the max size of one history, callsetMaxSize(int)instead.- Since:
- jEdit 4.5pre1
-
getDefaultMaxSize
public static int getDefaultMaxSize()Gets the default maximum size (in characters) for all history models.- Since:
- jEdit 4.5pre1
-
setSaver
-