com.sencha.gxt.theme.base.client.tree.TreeBaseAppearance.java Source code

Java tutorial

Introduction

Here is the source code for com.sencha.gxt.theme.base.client.tree.TreeBaseAppearance.java

Source

/**
 * Sencha GXT 4.0.0 - Sencha for GWT
 * Copyright (c) 2006-2015, Sencha Inc.
 *
 * licensing@sencha.com
 * http://www.sencha.com/products/gxt/license/
 *
 * ================================================================================
 * Open Source License
 * ================================================================================
 * This version of Sencha GXT is licensed under the terms of the Open Source GPL v3
 * license. You may use this license only if you are prepared to distribute and
 * share the source code of your application under the GPL v3 license:
 * http://www.gnu.org/licenses/gpl.html
 *
 * If you are NOT prepared to distribute and share the source code of your
 * application under the GPL v3 license, other commercial and oem licenses
 * are available for an alternate download of Sencha GXT.
 *
 * Please see the Sencha GXT Licensing page at:
 * http://www.sencha.com/products/gxt/license/
 *
 * For clarification or additional options, please contact:
 * licensing@sencha.com
 * ================================================================================
 *
 *
 * ================================================================================
 * Disclaimer
 * ================================================================================
 * THIS SOFTWARE IS DISTRIBUTED "AS-IS" WITHOUT ANY WARRANTIES, CONDITIONS AND
 * REPRESENTATIONS WHETHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE
 * IMPLIED WARRANTIES AND CONDITIONS OF MERCHANTABILITY, MERCHANTABLE QUALITY,
 * FITNESS FOR A PARTICULAR PURPOSE, DURABILITY, NON-INFRINGEMENT, PERFORMANCE AND
 * THOSE ARISING BY STATUTE OR FROM CUSTOM OR USAGE OF TRADE OR COURSE OF DEALING.
 * ================================================================================
 */
package com.sencha.gxt.theme.base.client.tree;

import com.google.gwt.dom.client.Element;
import com.google.gwt.resources.client.ClientBundle.Source;
import com.google.gwt.resources.client.CssResource;
import com.google.gwt.resources.client.ImageResource;
import com.google.gwt.safehtml.shared.SafeHtml;
import com.google.gwt.safehtml.shared.SafeHtmlBuilder;
import com.google.gwt.safehtml.shared.SafeHtmlUtils;
import com.google.gwt.user.client.DOM;
import com.google.gwt.user.client.ui.AbstractImagePrototype;
import com.sencha.gxt.core.client.GXT;
import com.sencha.gxt.core.client.dom.XDOM;
import com.sencha.gxt.core.client.dom.XElement;
import com.sencha.gxt.widget.core.client.tree.Tree.CheckState;
import com.sencha.gxt.widget.core.client.tree.Tree.Joint;
import com.sencha.gxt.widget.core.client.tree.Tree.TreeAppearance;
import com.sencha.gxt.widget.core.client.tree.TreeStyle;
import com.sencha.gxt.widget.core.client.tree.TreeView.TreeViewRenderMode;

public abstract class TreeBaseAppearance implements TreeAppearance {

    public interface TreeBaseStyle extends CssResource {
        String check();

        String container();

        String dragOver();

        String drop();

        String element();

        String icon();

        String joint();

        String node();

        String over();

        String selected();

        String text();

        String tree();

    }

    public interface TreeResources {

        ImageResource checked();

        ImageResource folderClosed();

        ImageResource folderOpened();

        @Source("treeCollapsed.png")
        ImageResource jointCollapsedIcon();

        @Source("treeExpanded.png")
        ImageResource jointExpandedIcon();

        @Source("loading.gif")
        ImageResource loadingIcon();

        ImageResource partialChecked();

        TreeBaseStyle style();

        ImageResource unchecked();

    }

    private final TreeResources resources;
    private final TreeBaseStyle style;

    protected String indentMarkupStart = "<img src='" + GXT.getBlankImageUrl() + "' style='height: 18px; width: ";

    protected String indentMarkupEnd = "px;' />";

    protected int indentWidth = 17;

    public TreeBaseAppearance(TreeResources resources) {
        this.resources = resources;
        this.style = this.resources.style();
        this.style.ensureInjected();
    }

    @Override
    public ImageResource closeNodeIcon() {
        return resources.folderClosed();
    }

    @Override
    public String elementSelector() {
        return "." + style.element();
    }

    public XElement findIconElement(XElement target) {
        return target.selectNode("." + style.icon());
    }

    @Override
    public XElement findJointElement(XElement target) {
        return target.selectNode("." + style.joint());
    }

    @Override
    public XElement getCheckElement(XElement container) {
        return container.getChildNodes().getItem(2).cast();
    }

    @Override
    public XElement getContainerElement(XElement node) {
        return node.getFirstChildElement().cast();
    }

    @Override
    public XElement getIconElement(XElement container) {
        return container.getChildNodes().getItem(3).cast();
    }

    @Override
    public XElement getJointElement(XElement container) {
        return container.getChildNodes().getItem(1).cast();
    }

    @Override
    public XElement getTextElement(XElement container) {
        return container.getChildNodes().getItem(4).cast();
    }

    @Override
    public boolean isCheckElement(XElement target) {
        return target.hasClassName(style.check());
    }

    @Override
    public boolean isJointElement(XElement target) {
        return target.hasClassName(style.joint());
    }

    @Override
    public String itemSelector() {
        return "." + style.node();
    }

    @Override
    public ImageResource loadingIcon() {
        return resources.loadingIcon();
    }

    @Override
    public XElement onCheckChange(XElement node, XElement checkElement, boolean checkable, CheckState state) {
        Element e = null;
        if (checkable) {
            switch (state) {
            case CHECKED:
                e = getImage(resources.checked());
                break;
            case UNCHECKED:
                e = getImage(resources.unchecked());
                break;
            case PARTIAL:
                e = getImage(resources.partialChecked());
                break;
            }
        } else {
            e = DOM.createSpan();
        }
        e.addClassName(style.check());
        e = (Element) node.getFirstChild().insertBefore(e, checkElement);
        checkElement.removeFromParent();
        return e.cast();
    }

    @Override
    public void onDropOver(XElement node, boolean over) {
        node.setClassName(style.dragOver(), over);
    }

    @Override
    public void onHover(XElement node, boolean over) {
        node.setClassName(style.over(), over);
    }

    @Override
    public XElement onJointChange(XElement node, XElement jointElement, Joint joint, TreeStyle ts) {
        Element e;
        switch (joint) {
        case COLLAPSED:
            e = getImage(ts.getJointCloseIcon() == null ? resources.jointCollapsedIcon() : ts.getJointCloseIcon());
            break;
        case EXPANDED:
            e = getImage(ts.getJointOpenIcon() == null ? resources.jointExpandedIcon() : ts.getJointOpenIcon());
            break;
        default:
            e = XDOM.create(SafeHtmlUtils
                    .fromTrustedString("<img src=\"" + GXT.getBlankImageUrl() + "\" width=\"16px\"/>"));
        }

        e.addClassName(style.joint());
        e = (Element) node.getFirstChild().insertBefore(e, jointElement);
        jointElement.removeFromParent();
        return e.cast();
    }

    @Override
    public void onSelect(XElement node, boolean select) {
        node.setClassName(style.selected(), select);
    }

    @Override
    public ImageResource openNodeIcon() {
        return resources.folderOpened();
    }

    @Override
    public void render(SafeHtmlBuilder sb) {
        sb.appendHtmlConstant("<div class=" + style.tree()
                + " style=\"position: relative;\"><table cellpadding=0 cellspacing=0 width=100%><tr><td></td></tr></table></div>");
    }

    @Override
    public void renderContainer(SafeHtmlBuilder sb) {
        sb.appendHtmlConstant("<div class='" + style.container() + "' role='group'></div>");
    }

    @Override
    public void renderNode(SafeHtmlBuilder sb, String id, SafeHtml text, TreeStyle ts, ImageResource icon,
            boolean checkable, CheckState checked, Joint joint, int level, TreeViewRenderMode renderMode) {

        if (renderMode == TreeViewRenderMode.ALL || renderMode == TreeViewRenderMode.BUFFER_WRAP) {
            sb.appendHtmlConstant(
                    "<div id=\"" + SafeHtmlUtils.htmlEscape(id) + "\" class=\"" + style.node() + "\">");

            sb.appendHtmlConstant("<div class=\"" + style.element() + "\">");
        }

        if (renderMode == TreeViewRenderMode.ALL || renderMode == TreeViewRenderMode.BUFFER_BODY) {

            sb.appendHtmlConstant(getIndentMarkup(level));

            Element jointElement = null;
            switch (joint) {
            case COLLAPSED:
                jointElement = getImage(
                        ts.getJointCloseIcon() == null ? resources.jointCollapsedIcon() : ts.getJointCloseIcon());
                break;
            case EXPANDED:
                jointElement = getImage(
                        ts.getJointOpenIcon() == null ? resources.jointExpandedIcon() : ts.getJointOpenIcon());
                break;
            default:
                // empty
            }

            if (jointElement != null) {
                jointElement.addClassName(style.joint());
            }

            sb.appendHtmlConstant(
                    jointElement == null
                            ? "<img src=\"" + GXT.getBlankImageUrl() + "\" style=\"width: 16px\" class=\""
                                    + style.joint() + "\" />"
                            : jointElement.getString());

            // checkable
            if (checkable) {
                Element e = null;
                switch (checked) {
                case CHECKED:
                    e = getImage(resources.checked());
                    break;
                case UNCHECKED:
                    e = getImage(resources.unchecked());
                    break;
                case PARTIAL:
                    e = getImage(resources.partialChecked());
                    break;
                }

                e.addClassName(style.check());
                sb.appendHtmlConstant(e.getString());
            } else {
                sb.appendHtmlConstant("<span class='" + style.check() + "'></span>");
            }

            if (icon != null) {
                Element e = getImage(icon);
                e.addClassName(style.icon());
                sb.appendHtmlConstant(e.getString());
            } else {
                sb.appendHtmlConstant("<span class=\"" + style.icon() + "\"></span>");
            }

            sb.appendHtmlConstant("<span class=\"" + style.text() + "\">" + text.asString() + "</span>");
        }

        if (renderMode == TreeViewRenderMode.ALL || renderMode == TreeViewRenderMode.BUFFER_WRAP) {
            sb.appendHtmlConstant("</div>");
            sb.appendHtmlConstant("</div>");
        }

    }

    @Override
    public String textSelector() {
        return "." + style.text();
    }

    protected String getIndentMarkup(int level) {
        return indentMarkupStart + (indentWidth * level) + indentMarkupEnd;
    }

    private Element getImage(ImageResource ir) {
        return AbstractImagePrototype.create(ir).createElement();
    }

}