Class BasicXListUI

  • Direct Known Subclasses:
    SynthXListUI

    public class BasicXListUI
    extends BasicListUI
    An extensible implementation of ListUI for JXList. BasicXListUI instances cannot be shared between multiple lists.

    The heart of added functionality is to support sorting/filtering, that is keep model-selection and RowSorter state synchronized. The details are delegated to a ListSortUI, but this class is responsible to manage the sortUI on changes of list properties, model and view selection (same strategy as in JXTable).

    Note: this delegate is mostly a 1:1 copy of BasicListUI. The difference is that it accesses the list elements and list elementCount exclusively through the JXList api. This allows a clean implementation of sorting/filtering.

    The differences (goal was to touch as little code as possible as this needs to be updated on every change to core until that is changed to not access the list's model directly, sigh) for core functionality:

    • extracted method for list.getModel().getSize (for the delegate class and all contained static classes) and use that method exclusively
    • similar for remaining list.getModel(): implemented wrapping listModel which messages the list
    • rename key for shared actionMap to keep core list actions separate (just in case somebody wants both) - they point to the wrong delegate
    • replaced references to SwingUtilities2 in sun packages by references to c&p'ed methods in SwingXUtilities
    • replaced storage of shared Input/ActionMap in defaultLookup by direct storage in UIManager.
    Differences to achieve extended functionality:
    • added methods to un/-installSortUI and call in un/installUI(component)
    • changed PropertyChangeHandler to call a) hasHandledPropertyChange to allow this class to replace super handler functinality and b) updateSortUI after handling all not-sorter related properties.
    • changed createPropertyChangeListener to return a PropertyChangeHandler
    • changed ListDataHandler to check if event handled by SortUI and delegate to handler only if not
    • changed createListDataListener to return a ListDataHandler
    • changed ListSelectionHandler to check if event handled by SortUI and delegate to handler only if not
    changed createListSelectionListener to return a ListSelectionHandler Note: extension of core (instead of implement from scratch) is to keep external (?) code working which expects a ui delegate of type BasicSomething. LAF implementors with a custom ListUI extending BasicListUI should be able to add support for JXList by adding a separate CustomXListUI extending this, same as the default with parent changed. Beware: custom code must not call access the model directly or - if they insist - convert the row index to account for sorting/filtering! That's the whole point of this class.
    Version:
    1.127 12/02/08
    Author:
    Hans Muller, Philip Milne, Shannon Hickey (drag and drop)
    • Constructor Detail

      • BasicXListUI

        public BasicXListUI()
    • Method Detail

      • loadActionMap

        public static void loadActionMap​(LazyActionMap map)
      • getViewModel

        protected ListModel getViewModel()
        Compatibility Wrapper: a synthetic model which delegates to list api and throws
        Returns:
      • getElementCount

        protected int getElementCount()
        Returns:
      • getElementAt

        protected Object getElementAt​(int viewIndex)
      • installSortUI

        protected void installSortUI()
        Installs SortUI if the list has a rowSorter. Does nothing if not.
      • uninstallSortUI

        protected void uninstallSortUI()
        Dispose and null's the sortUI if installed. Does nothing if not.
      • updateSortUI

        protected void updateSortUI​(String property)
        Called from the PropertyChangeHandler.
        Parameters:
        property - the name of the changed property.
      • processedBySortUI

        protected boolean processedBySortUI​(ListDataEvent e)
        Returns a boolean indicating whether or not the event has been processed by the sortUI.
        Parameters:
        e -
        Returns:
      • processedBySortUI

        protected boolean processedBySortUI​(ListSelectionEvent e)
        Returns a boolean indicating whether or not the event has been processed by the sortUI.
        Parameters:
        e -
        Returns:
      • invalidateCellSizeCache

        public void invalidateCellSizeCache()
        Invalidates the cell size cache and revalidates/-paints the list.
      • getPreferredSize

        public Dimension getPreferredSize​(JComponent c)
        The preferredSize of the list depends upon the layout orientation.
        Layout OrientationPreferred Size
        JList.VERTICAL The preferredSize of the list is total height of the rows and the maximum width of the cells. If JList.fixedCellHeight is specified then the total height of the rows is just (cellVerticalMargins + fixedCellHeight) * model.getSize() where rowVerticalMargins is the space we allocate for drawing the yellow focus outline. Similarly if fixedCellWidth is specified then we just use that.
        JList.VERTICAL_WRAP If the visible row count is greater than zero, the preferredHeight is the maximum cell height * visibleRowCount. If the visible row count is <= 0, the preferred height is either the current height of the list, or the maximum cell height, whichever is bigger. The preferred width is than the maximum cell width * number of columns needed. Where the number of columns needs is list.height / max cell height. Max cell height is either the fixed cell height, or is determined by iterating through all the cells to find the maximum height from the ListCellRenderer.
        JList.HORIZONTAL_WRAP If the visible row count is greater than zero, the preferredHeight is the maximum cell height * adjustedRowCount. Where visibleRowCount is used to determine the number of columns. Because this lays out horizontally the number of rows is then determined from the column count. For example, lets say you have a model with 10 items and the visible row count is 8. The number of columns needed to display this is 2, but you no longer need 8 rows to display this, you only need 5, thus the adjustedRowCount is 5.

        If the visible row count is <= 0, the preferred height is dictated by the number of columns, which will be as many as can fit in the width of the JList (width / max cell width), with at least one column. The preferred height then becomes the model size / number of columns * maximum cell height. Max cell height is either the fixed cell height, or is determined by iterating through all the cells to find the maximum height from the ListCellRenderer.

        The above specifies the raw preferred width and height. The resulting preferred width is the above width + insets.left + insets.right and the resulting preferred height is the above height + insets.top + insets.bottom. Where the Insets are determined from list.getInsets().
        Overrides:
        getPreferredSize in class BasicListUI
        Parameters:
        c - The JList component.
        Returns:
        The total size of the list.
      • uninstallKeyboardActions

        protected void uninstallKeyboardActions()
        Unregisters keyboard actions installed from installKeyboardActions. This method is called at uninstallUI() time - subclassess should ensure that all of the keyboard actions registered at installUI time are removed here.
        Overrides:
        uninstallKeyboardActions in class BasicListUI
        See Also:
        installUI(javax.swing.JComponent)
      • createUI

        public static ComponentUI createUI​(JComponent list)
        Returns a new instance of BasicXListUI. BasicXListUI delegates are allocated one per JList.
        Returns:
        A new ListUI implementation for the Windows look and feel.
      • convertYToRow

        protected int convertYToRow​(int y0)
        Convert the JList relative coordinate to the row that contains it, based on the current layout. If y0 doesn't fall within any row, return -1.
        Overrides:
        convertYToRow in class BasicListUI
        Returns:
        The row that contains y0, or -1.
        See Also:
        getRowHeight(int), updateLayoutState()
      • convertRowToY

        protected int convertRowToY​(int row)
        Return the JList relative Y coordinate of the origin of the specified row or -1 if row isn't valid.
        Overrides:
        convertRowToY in class BasicListUI
        Returns:
        The Y coordinate of the origin of row, or -1.
        See Also:
        getRowHeight(int), updateLayoutState()
      • maybeUpdateLayoutState

        protected void maybeUpdateLayoutState()
        If updateLayoutStateNeeded is non zero, call updateLayoutState() and reset updateLayoutStateNeeded. This method should be called by methods before doing any computation based on the geometry of the list. For example it's the first call in paint() and getPreferredSize().
        Overrides:
        maybeUpdateLayoutState in class BasicListUI
        See Also:
        updateLayoutState()
      • updateLayoutState

        protected void updateLayoutState()
        Recompute the value of cellHeight or cellHeights based and cellWidth, based on the current font and the current values of fixedCellWidth, fixedCellHeight, and prototypeCellValue.
        Overrides:
        updateLayoutState in class BasicListUI
        See Also:
        maybeUpdateLayoutState()
      • createMouseInputListener

        protected MouseInputListener createMouseInputListener()
        Creates a delegate that implements MouseInputListener. The delegate is added to the corresponding java.awt.Component listener lists at installUI() time. Subclasses can override this method to return a custom MouseInputListener, e.g.
         class MyListUI extends BasicXListUI {
            protected MouseInputListener createMouseInputListener() {
                return new MyMouseInputHandler();
            }
            public class MyMouseInputHandler extends MouseInputHandler {
                public void mouseMoved(MouseEvent e) {
                    // do some extra work when the mouse moves
                    super.mouseMoved(e);
                }
            }
         }
         
        Overrides:
        createMouseInputListener in class BasicListUI
        See Also:
        BasicXListUI.MouseInputHandler, installUI(javax.swing.JComponent)
      • createListSelectionListener

        protected ListSelectionListener createListSelectionListener()
        Creates an instance of ListSelectionHandler that's added to the JLists by selectionModel as needed. Subclasses can override this method to return a custom ListSelectionListener, e.g.
         class MyListUI extends BasicXListUI {
            protected ListSelectionListener createListSelectionListener() {
                return new MySelectionListener();
            }
            public class MySelectionListener extends ListSelectionHandler {
                public void valueChanged(ListSelectionEvent e) {
                    // do some extra work when the selection changes
                    super.valueChange(e);
                }
            }
         }
         
        Overrides:
        createListSelectionListener in class BasicListUI
        See Also:
        BasicXListUI.ListSelectionHandler, installUI(javax.swing.JComponent)
      • createListDataListener

        protected ListDataListener createListDataListener()
        Creates an instance of ListDataListener that's added to the JLists by model as needed. Subclasses can override this method to return a custom ListDataListener, e.g.
         class MyListUI extends BasicXListUI {
            protected ListDataListener createListDataListener() {
                return new MyListDataListener();
            }
            public class MyListDataListener extends ListDataHandler {
                public void contentsChanged(ListDataEvent e) {
                    // do some extra work when the models contents change
                    super.contentsChange(e);
                }
            }
         }
         
        Overrides:
        createListDataListener in class BasicListUI
        See Also:
        ListDataListener, JList.getModel(), installUI(javax.swing.JComponent)
      • createPropertyChangeListener

        protected PropertyChangeListener createPropertyChangeListener()
        Creates an instance of PropertyChangeHandler that's added to the JList by installUI(). Subclasses can override this method to return a custom PropertyChangeListener, e.g.
         class MyListUI extends BasicXListUI {
            protected PropertyChangeListener createPropertyChangeListener() {
                return new MyPropertyChangeListener();
            }
            public class MyPropertyChangeListener extends PropertyChangeHandler {
                public void propertyChange(PropertyChangeEvent e) {
                    if (e.getPropertyName().equals("model")) {
                        // do some extra work when the model changes
                    }
                    super.propertyChange(e);
                }
            }
         }
         
        Overrides:
        createPropertyChangeListener in class BasicListUI
        See Also:
        PropertyChangeListener, installUI(javax.swing.JComponent)