Module jEdit

Class HistoryModel

All Implemented Interfaces:
Serializable, ListModel<String>, MutableListModel<String>

public class HistoryModel extends DefaultListModel<String> implements 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:
  • Constructor Details

    • HistoryModel

      public HistoryModel(String name)
      Creates a new history list. Calling this is normally not necessary.
  • Method Details

    • addItem

      public void addItem(String text)
      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

      public void insertElementAt(String obj, int index)
      Specified by:
      insertElementAt in interface MutableListModel<String>
      Overrides:
      insertElementAt in class DefaultListModel<String>
    • getItem

      public String getItem(int index)
      Returns an item from the history list.
      Parameters:
      index - The index
    • removeElement

      public boolean removeElement(Object obj)
      Specified by:
      removeElement in interface MutableListModel<String>
      Overrides:
      removeElement in class DefaultListModel<String>
    • removeAllElements

      public void removeAllElements()
      Overrides:
      removeAllElements in class DefaultListModel<String>
    • getName

      public String getName()
      Returns the name of this history list. This can be passed to the HistoryTextField constructor.
    • getModel

      public static HistoryModel getModel(String name)
      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, call setMaxSize(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

      public static void setSaver(HistoryModelSaver saver)