CategoryRenderer.java

/*******************************************************************************
 * Copyright (c) 2012-2017 Codenvy, S.A.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *   Codenvy, S.A. - initial API and implementation
 *******************************************************************************/
package org.eclipse.che.ide.ui.list;

import com.google.gwt.dom.client.Element;
import com.google.gwt.user.client.DOM;

/**
 * Called each time we render an item in the list. Provides an opportunity for
 * implementors/clients to customize the DOM structure of each list item.
 *
 * @author Evgen Vidolob
 */
public abstract class CategoryRenderer<T> {

    public abstract void renderElement(Element element, T data);

    public abstract Element renderCategory(Category<T> category);

    /**
     * A factory method for the outermost element used by a list item.
     * <p/>
     * The default implementation returns a div element.
     *
     * @return the element
     */
    public Element createElement() {
        return DOM.createDiv();
    }

    /**
     * A factory method for the category element used by a list item.
     * <p/>
     * The default implementation returns a span element.
     *
     * @return the element
     */
    public Element createCategoryElement() {
        return DOM.createSpan();
    }
}