Home » openjdk-7 » javax » swing » plaf » basic » [javadoc | source]
javax.swing.plaf.basic
public class: BasicListUI [javadoc | source]
java.lang.Object
   javax.swing.plaf.ComponentUI
      javax.swing.plaf.ListUI
         javax.swing.plaf.basic.BasicListUI

Direct Known Subclasses:
    SynthListUI

An extensible implementation of {@code ListUI}.

{@code BasicListUI} instances cannot be shared between multiple lists.

Nested Class Summary:
public class  BasicListUI.MouseInputHandler  Mouse input, and focus handling for JList. An instance of this class is added to the appropriate java.awt.Component lists at installUI() time. Note keyboard input is handled with JComponent KeyboardActions, see installKeyboardActions().

Warning: Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. As of 1.4, support for long term storage of all JavaBeansTM has been added to the java.beans package. Please see {@link java.beans.XMLEncoder}. 

public class  BasicListUI.FocusHandler  This class should be treated as a "protected" inner class. Instantiate it only within subclasses of {@code BasicListUI}. 
public class  BasicListUI.ListSelectionHandler  The ListSelectionListener that's added to the JLists selection model at installUI time, and whenever the JList.selectionModel property changes. When the selection changes we repaint the affected rows.

Warning: Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. As of 1.4, support for long term storage of all JavaBeansTM has been added to the java.beans package. Please see {@link java.beans.XMLEncoder}. 

public class  BasicListUI.ListDataHandler  The ListDataListener that's added to the JLists model at installUI time, and whenever the JList.model property changes.

Warning: Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. As of 1.4, support for long term storage of all JavaBeansTM has been added to the java.beans package. Please see {@link java.beans.XMLEncoder}. 

public class  BasicListUI.PropertyChangeHandler  The PropertyChangeListener that's added to the JList at installUI time. When the value of a JList property that affects layout changes, we set a bit in updateLayoutStateNeeded. If the JLists model changes we additionally remove our listeners from the old model. Likewise for the JList selectionModel.

Warning: Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. As of 1.4, support for long term storage of all JavaBeansTM has been added to the java.beans package. Please see {@link java.beans.XMLEncoder}. 

static class  BasicListUI.ListTransferHandler   
Field Summary
protected  JList list     
protected  CellRendererPane rendererPane     
protected  FocusListener focusListener     
protected  MouseInputListener mouseInputListener     
protected  ListSelectionListener listSelectionListener     
protected  ListDataListener listDataListener     
protected  PropertyChangeListener propertyChangeListener     
protected  int[] cellHeights     
protected  int cellHeight     
protected  int cellWidth     
protected  int updateLayoutStateNeeded     
protected static final  int modelChanged     
protected static final  int selectionModelChanged     
protected static final  int fontChanged     
protected static final  int fixedCellWidthChanged     
protected static final  int fixedCellHeightChanged     
protected static final  int prototypeCellValueChanged     
protected static final  int cellRendererChanged     
Method from javax.swing.plaf.basic.BasicListUI Summary:
convertRowToY,   convertYToRow,   createFocusListener,   createListDataListener,   createListSelectionListener,   createMouseInputListener,   createPropertyChangeListener,   createUI,   getBaseline,   getBaselineResizeBehavior,   getCellBounds,   getInputMap,   getPreferredSize,   getRowHeight,   indexToLocation,   installDefaults,   installKeyboardActions,   installListeners,   installUI,   loadActionMap,   locationToIndex,   maybeUpdateLayoutState,   paint,   paintCell,   selectNextIndex,   selectPreviousIndex,   uninstallDefaults,   uninstallKeyboardActions,   uninstallListeners,   uninstallUI,   updateLayoutState
Methods from javax.swing.plaf.ListUI:
getCellBounds,   indexToLocation,   locationToIndex
Methods from javax.swing.plaf.ComponentUI:
contains,   createUI,   getAccessibleChild,   getAccessibleChildrenCount,   getBaseline,   getBaselineResizeBehavior,   getMaximumSize,   getMinimumSize,   getPreferredSize,   installUI,   paint,   uninstallUI,   update
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from javax.swing.plaf.basic.BasicListUI Detail:
 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.
 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.
 protected FocusListener createFocusListener() 
 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 BasicListUI {
       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);
           }
       }
    }
    
 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 BasicListUI {
       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);
           }
       }
    }
    
 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 BasicListUI {
       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);
           }
       }
    }
    
 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 BasicListUI {
       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);
           }
       }
    }
    
 public static ComponentUI createUI(JComponent list) 
    Returns a new instance of BasicListUI. BasicListUI delegates are allocated one per JList.
 public int getBaseline(JComponent c,
    int width,
    int height) 
    Returns the baseline.
 public BaselineResizeBehavior getBaselineResizeBehavior(JComponent c) 
    Returns an enum indicating how the baseline of the component changes as the size changes.
 public Rectangle getCellBounds(JList list,
    int index1,
    int index2) 
    {@inheritDoc}
 InputMap getInputMap(int condition) 
 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().
 protected int getRowHeight(int row) 
    Returns the height of the specified row based on the current layout.
 public Point indexToLocation(JList list,
    int index) 
    {@inheritDoc}
 protected  void installDefaults() 
    Initializes list properties such as font, foreground, and background, and adds the CellRendererPane. The font, foreground, and background properties are only set if their current value is either null or a UIResource, other properties are set if the current value is null.
 protected  void installKeyboardActions() 
    Registers the keyboard bindings on the JList that the BasicListUI is associated with. This method is called at installUI() time.
 protected  void installListeners() 
    Creates and installs the listeners for the JList, its model, and its selectionModel. This method is called at installUI() time.
 public  void installUI(JComponent c) 
    Initializes this.list by calling installDefaults(), installListeners(), and installKeyboardActions() in order.
 static  void loadActionMap(LazyActionMap map) 
 public int locationToIndex(JList list,
    Point location) 
    {@inheritDoc}
 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().
 public  void paint(Graphics g,
    JComponent c) 
    Paint the rows that intersect the Graphics objects clipRect. This method calls paintCell as necessary. Subclasses may want to override these methods.
 protected  void paintCell(Graphics g,
    int row,
    Rectangle rowBounds,
    ListCellRenderer cellRenderer,
    ListModel dataModel,
    ListSelectionModel selModel,
    int leadIndex) 
    Paint one List cell: compute the relevant state, get the "rubber stamp" cell renderer component, and then use the CellRendererPane to paint it. Subclasses may want to override this method rather than paint().
 protected  void selectNextIndex() 
    Selected the previous row and force it to be visible.
 protected  void selectPreviousIndex() 
    Selected the previous row and force it to be visible.
 protected  void uninstallDefaults() 
    Sets the list properties that have not been explicitly overridden to {@code null}. A property is considered overridden if its current value is not a {@code UIResource}.
 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.
 protected  void uninstallListeners() 
    Removes the listeners from the JList, its model, and its selectionModel. All of the listener fields, are reset to null here. This method is called at uninstallUI() time, it should be kept in sync with installListeners.
 public  void uninstallUI(JComponent c) 
    Uninitializes this.list by calling uninstallListeners(), uninstallKeyboardActions(), and uninstallDefaults() in order. Sets this.list to null.
 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.