DefaultListCellRenderer.java

/*
 * Copyright 2008 Sun Microsystems, Inc.  All Rights Reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Sun designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Sun in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
 * CA 95054 USA or visit www.sun.com if you need additional information or
 * have any questions.
 */
package com.sun.lwuit.list;

import com.sun.lwuit.Command;
import com.sun.lwuit.Component;
import com.sun.lwuit.Label;
import com.sun.lwuit.List;
import com.sun.lwuit.plaf.UIManager;
import java.util.Hashtable;

/**
 * Default implementation of the renderer based on a label see the {@link ListCellRenderer}
 * for more information about the use and purpose of this class
 *
 * @author Chen Fishbein
 */
public class DefaultListCellRenderer extends Label implements ListCellRenderer {
    private boolean showNumbers;
    private static boolean showNumbersDefault = true;
    private Label focusComponent = new Label();
    
    /** 
     * Creates a new instance of DefaultCellRenderer 
     */
    public DefaultListCellRenderer() {
        super("");
        setCellRenderer(true);
        setEndsWith3Points(false);
        showNumbers = showNumbersDefault;
        focusComponent.setUIID("ListRendererFocus");
        focusComponent.setFocus(true);
        setUIID("ListRenderer");
    }

    /**
     * @inheritDoc
     */
    public void refreshTheme() {
        super.refreshTheme();
        focusComponent.refreshTheme();
    }

    /** 
     * Creates a new instance of DefaultCellRenderer 
     * 
     * @param showNumbers indicates numbers should be shown
     */
    public DefaultListCellRenderer(boolean showNumbers) {
        this();
        this.showNumbers = showNumbers;
    }

    /**
     * @inheritDoc
     */
    public Component getListCellRendererComponent(List list, Object value, int index, boolean isSelected) {
        setFocus(isSelected);
        if(showNumbers) {
            String text = "" + value;
            Hashtable t =  UIManager.getInstance().getResourceBundle();
            if(t != null && value != null) {
                Object o = t.get(value.toString());
                if(o != null) {
                    text = (String)o;
                }
            }
            if(isRTL()){
                setText(text+ " ." + (index + 1));
            }else{
                setText("" + (index + 1) + ". " + text);
            }
        } else {
            if(value != null) {
                setText(value.toString());
            } else {
                setText("null");
            }
        }
        if(value instanceof Command) {
            setIcon(((Command)value).getIcon());
        }
        return this;
    }

    /**
     * @inheritDoc
     */
    public Component getListFocusComponent(List list) {
        return focusComponent;
    }
    /**
     * Overriden to do nothing and remove a performance issue where renderer changes
     * perform needless repaint calls
     */
    public void repaint() {
    }

    /**
     * Indicate whether numbering should exist for the default cell renderer
     * 
     * @return true if numers are shown by the numbers
     */
    public boolean isShowNumbers() {
        return showNumbers;
    }

    /**
     * Indicate whether numbering should exist for the default cell renderer
     * 
     * @param showNumbers indicate whether numbering should exist for the default cell renderer
     */
    public void setShowNumbers(boolean showNumbers) {
        this.showNumbers = showNumbers;
    }

    /**
     * The background transparency factor to apply to the selection focus
     * 
     * @return selection transperancy value
     */
    public int getSelectionTransparency() {
        return focusComponent.getUnselectedStyle().getBgTransparency() & 0xff;
    }

    /**
     * The background transparency factor to apply to the selection focus
     * 
     * @param selectionTransparency the selection transperancy value
     */
    public void setSelectionTransparency(int selectionTransparency) {
        focusComponent.getUnselectedStyle().setBgTransparency(selectionTransparency);
    }

    /**
     * Inidicates whether the default list cell renderer will show numbers by default
     * when constructed
     *
     * @param def true to show numbers for all renderers created in the future
     */
    public static void setShowNumbersDefault(boolean def) {
        showNumbersDefault = def;
    }

    /**
     * Inidicates whether the default list cell renderer will show numbers by default
     * when constructed
     *
     * @return true when showing numbers, false otherwise
     */
    public static boolean isShowNumbersDefault() {
        return showNumbersDefault;
    }
}