com.github.gwtbootstrap.client.ui.base.DropdownBase Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gwt-bootstrap Show documentation
A GWT Library that provides the widgets of Twitter Bootstrap.
The newest version!
/*
 *  Copyright 2012 GWT-Bootstrap
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */
package com.github.gwtbootstrap.client.ui.base;

import com.github.gwtbootstrap.client.ui.NavLink;
import com.github.gwtbootstrap.client.ui.constants.Alignment;
import com.github.gwtbootstrap.client.ui.constants.Constants;
import com.google.gwt.core.client.GWT;
import com.google.gwt.dom.client.Document;
import com.google.gwt.dom.client.Element;
import com.google.gwt.event.dom.client.*;
import com.google.gwt.event.shared.HandlerRegistration;
import com.google.gwt.uibinder.client.UiChild;
import com.google.gwt.user.client.ui.HasText;
import com.google.gwt.user.client.ui.HasWidgets;
import com.google.gwt.user.client.ui.Widget;

//@formatter:off

/**
 * Base class for dropdown widgets.
 *
 * @author Carlos A Becker
 * @author Dominik Mayer
 *
 * @since 2.0.4.0
 */
//@formatter:on
public abstract class DropdownBase extends ComplexWidget implements HasChangeHandlers, HasClickHandlers, HasWidgets, HasText, HasIcon {

    private UnorderedList menu = new UnorderedList();

    protected IconAnchor trigger;

    private NavLink link;

    private NavLinkClickHandler handler = new NavLinkClickHandler();

    private boolean dropup;

    /**
     * Creates a new widget of the given type.
     *
     * @param type the HTML tag to be used for the widget
     */
    public DropdownBase(String type) {
        super(type);
        createAndAddTrigger();
        menu.setStyleName("dropdown-menu");
        super.add(menu);
    }

    private void createAndAddTrigger() {
        trigger = createTrigger();
        // Prevents exception when the impl class does not have a trigger.
        if (trigger != null) {
            trigger.addStyleName("dropdown-toggle");
            trigger.getElement().setAttribute(Constants.DATA_TOGGLE, "dropdown");
            super.add(trigger);
        }
    }

    /**
     * Sets the text of the dropdown trigger.
     *
     * @param text
     */
    public void setText(String text) {
        trigger.setText(text);
    }

    /**
     * @return the text of the dropdown trigger.
     */
    public String getText() {
        return trigger.getText();
    }

    /**
     * Get trigger wiget
     *
     * @return trigger wiget
     */
    public IconAnchor getTriggerWidget() {
        return trigger;
    }


    /**
     * Get menu unordered list widget
     *
     * @return menu
     */
    public UnorderedList getMenuWiget() {
        return menu;
    }

    /**
     * Implement this method to create the trigger appropriate for your widget.
     * It has to be an {@link IconAnchor} or a subtype.
     *
     * @return the created trigger
     */
    protected abstract IconAnchor createTrigger();

    /**
     * Set dropup style.
     *
     * @param dropup true:Set Dropup false:Un-set Dropup
     */
    public void setDropup(boolean dropup) {

        this.dropup = dropup;

        if (dropup)
            addStyleName(Constants.DROPUP);
        else
            removeStyleName(Constants.DROPUP);
    }

    /**
     * Is widget dropup?
     *
     * @return true:Dropup false:Dropdown
     */
    public boolean isDropup() {
        return this.dropup;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    protected void onLoad() {
        super.onLoad();
        if (trigger != null) {
            configure(trigger.getElement());
        }
    }

    /**
     * Adds a widget to the dropdown menu.
     *
     * @param widget the widget that will be added to the menu
     * @see #addWidget(Widget)
     */
    @Override
    public void add(Widget widget) {
        menu.add(widget);
        if (widget instanceof NavLink) {
            ((NavLink) widget).addClickHandler(handler);
        }
    }

    @Override
    public HandlerRegistration addChangeHandler(ChangeHandler handler) {
        return addDomHandler(handler, ChangeEvent.getType());
    }

    /**
     * Adds a widget to the the dropdown widget, not to the dropdown
     * menu.
     * 
     * 
     * Use {@link #add(Widget)} if you want to add a widget to the dropdown
     * menu.
     *
     * @param widget the widget to be added.
     */
    protected void addWidget(Widget widget) {
        super.add(widget);
    }

    private native void configure(Element e) /*-{
        $wnd.jQuery(e).dropdown();
    }-*/;

    /**
     * Pull the dropdown menu to right
     *
     * @param rightDropdown true pull to right, otherwise to left. Default is
     *                      false
     */
    public void setRightDropdown(boolean rightDropdown) {
        menu.setStyleName(Alignment.RIGHT.get(), rightDropdown);
    }

    private class NavLinkClickHandler implements ClickHandler {

        @Override
        public void onClick(ClickEvent event) {
            try {
                IconAnchor iconAnchor = (IconAnchor) event.getSource();
                link = (NavLink) iconAnchor.getParent();
            } catch (Exception e) {
                GWT.log(e.getMessage(), e);
            }
            DomEvent.fireNativeEvent(Document.get().createChangeEvent(), DropdownBase.this);
        }

    }

    /**
     * Method to get the {@link NavLink} that has been clicked most recently.
     *
     * @return Last clicked NavLink or null if none have been
     *         clicked.
     */
    public NavLink getLastSelectedNavLink() {
        return link;
    }

    @Override
    public void clear() {
        menu.clear();
    }

    @Override
    public HandlerRegistration addClickHandler(ClickHandler handler) {
        return trigger.addClickHandler(handler);
    }

    /**
     * Add widget to trigger anchodr
     *
     * @param w added widget
     */
    @UiChild(tagname = "customTrigger", limit = 1)
    public void addCustomTrigger(Widget w) {
        trigger.insert(w, 0);
    }

}