• Home
• com.arcbees
• gwtchosen
• 3.0.1
• source code
• ChosenListBox.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.arcbees.chosen.client.gwt.ChosenListBox Maven / Gradle / Ivy

/**
 * Copyright 2015 ArcBees Inc.
 *
 * 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.arcbees.chosen.client.gwt;

import java.util.List;

import com.arcbees.chosen.client.ChosenImpl;
import com.arcbees.chosen.client.ChosenOptions;
import com.arcbees.chosen.client.event.ChosenChangeEvent;
import com.arcbees.chosen.client.event.ChosenChangeEvent.ChosenChangeHandler;
import com.arcbees.chosen.client.event.HasAllChosenHandlers;
import com.arcbees.chosen.client.event.HidingDropDownEvent;
import com.arcbees.chosen.client.event.HidingDropDownEvent.HidingDropDownHandler;
import com.arcbees.chosen.client.event.MaxSelectedEvent;
import com.arcbees.chosen.client.event.MaxSelectedEvent.MaxSelectedHandler;
import com.arcbees.chosen.client.event.ReadyEvent;
import com.arcbees.chosen.client.event.ReadyEvent.ReadyHandler;
import com.arcbees.chosen.client.event.ShowingDropDownEvent;
import com.arcbees.chosen.client.event.ShowingDropDownEvent.ShowingDropDownHandler;
import com.arcbees.chosen.client.event.UpdatedEvent;
import com.arcbees.chosen.client.event.UpdatedEvent.UpdatedHandler;
import com.arcbees.chosen.client.resources.Resources;
import com.google.gwt.core.client.GWT;
import com.google.gwt.core.client.JsArrayString;
import com.google.gwt.dom.client.Document;
import com.google.gwt.dom.client.Element;
import com.google.gwt.dom.client.NodeList;
import com.google.gwt.dom.client.OptionElement;
import com.google.gwt.dom.client.SelectElement;
import com.google.gwt.event.dom.client.DomEvent.Type;
import com.google.gwt.event.shared.EventHandler;
import com.google.gwt.event.shared.LegacyHandlerWrapper;
import com.google.gwt.i18n.client.HasDirection.Direction;
import com.google.gwt.query.client.GQuery;
import com.google.gwt.user.client.ui.ListBox;
import com.google.gwt.user.client.ui.RootPanel;
import com.google.gwt.user.client.ui.Widget;
import com.google.web.bindery.event.shared.EventBus;
import com.google.web.bindery.event.shared.HandlerRegistration;
import com.google.web.bindery.event.shared.SimpleEventBus;

import static com.arcbees.chosen.client.Chosen.CHOSEN_DATA_KEY;
import static com.arcbees.chosen.client.Chosen.Chosen;
import static com.google.gwt.query.client.GQuery.$;

public class ChosenListBox extends ListBox implements HasAllChosenHandlers {
    private static final String OPTGROUP_TAG = "optgroup";

    private EventBus chznHandlerManager;
    private ChosenOptions options;
    private boolean visible = true;

    /**
     * Creates an empty chosen component in single selection mode.
     */
    public ChosenListBox() {
        this(false);
    }

    /**
     * Creates an empty chosen component in single selection mode.
     */
    public ChosenListBox(ChosenOptions options) {
        this(false, options);
    }

    /**
     * Creates an empty list box. The preferred way to enable multiple
     * selections is to use this constructor rather than
     * {@link #setMultipleSelect(boolean)}.
     *
     * @param isMultipleSelect specifies if multiple selection is enabled
     */
    public ChosenListBox(boolean isMultipleSelect) {
        this(isMultipleSelect, new ChosenOptions());
    }

    /**
     * Creates an empty list box. The preferred way to enable multiple
     * selections is to use this constructor rather than
     * {@link #setMultipleSelect(boolean)}.
     *
     * @param isMultipleSelect specifies if multiple selection is enabled
     */
    public ChosenListBox(boolean isMultipleSelect, ChosenOptions options) {
        super(Document.get().createSelectElement(isMultipleSelect));
        this.options = options;
        if (options.getResources() == null) {
            options.setResources(GWT.create(Resources.class));
        }
    }

    protected ChosenListBox(Element element) {
        super(element);
    }

    /**
     * Creates a ChosenListBox widget that wraps an existing <select>
     * element.
     * 

     * This element must already be attached to the document. If the element is
     * removed from the document, you must call
     * {@link RootPanel#detachNow(Widget)}.
     *
     * @param element the element to be wrapped
     * @return list box
     */
    public static ChosenListBox wrap(Element element) {
        assert Document.get().getBody().isOrHasChild(element);

        ChosenListBox listBox = new ChosenListBox(element);

        listBox.onAttach();
        RootPanel.detachOnWindowClose(listBox);

        return listBox;
    }

    /**
     * Deprecated, use {@link #addChosenChangeHandler(ChosenChangeHandler)}
     * instead.
     */
    @Override
    @Deprecated
    public com.google.gwt.event.shared.HandlerRegistration addChangeHandler(
            final com.google.gwt.event.dom.client.ChangeHandler handler) {
        final HandlerRegistration registration = addChosenChangeHandler(new ChosenChangeHandler() {
            public void onChange(ChosenChangeEvent event) {
                handler.onChange(null);
            }
        });

        return new LegacyHandlerWrapper(registration);
    }

    public HandlerRegistration addChosenChangeHandler(
            ChosenChangeHandler handler) {
        return ensureChosenHandlers().addHandler(ChosenChangeEvent.getType(),
                handler);
    }

    /**
     * Adds a group at the end of the list box.
     *
     * @param label the text of the group to be added
     */
    public void addGroup(String label) {
        insertGroup(label, -1);
    }

    /**
     * Adds a group at the end of the list box.
     *
     * @param label   the text of the group to be added
     * @param groupId the id for the optgroup element
     */
    public void addGroup(String label, String groupId) {
        insertGroup(label, groupId, -1);
    }

    public HandlerRegistration addHidingDropDownHandler(
            HidingDropDownHandler handler) {
        return ensureChosenHandlers().addHandler(HidingDropDownEvent.getType(),
                handler);
    }

    /**
     * Adds an item to the last optgroup of the list box.
     *
     * @param item the text of the item to be added
     */
    public void addItemToGroup(String item) {
        insertItemToGroup(item, -1, -1);
    }

    /**
     * Adds an item to the an optgroup of the list box.
     *
     * @param item       the text of the item to be added
     * @param groupIndex the index of the optGroup where the item will be inserted
     */
    public void addItemToGroup(String item, int groupIndex) {
        insertItemToGroup(item, groupIndex, -1);
    }

    /**
     * Adds an item to the last optgroup of the list box.
     *
     * @param item the text of the item to be added
     */
    public void addItemToGroup(String item, String value) {
        insertItemToGroup(item, value, -1, -1);
    }

    /**
     * Adds an item to the an optgroup of the list box.
     *
     * @param item       the text of the item to be added
     * @param groupIndex the index of the optGroup where the item will be inserted
     */
    public void addItemToGroup(String item, String value, int groupIndex) {
        insertItemToGroup(item, value, groupIndex, -1);
    }

    public HandlerRegistration addMaxSelectedHandler(MaxSelectedHandler handler) {
        return ensureChosenHandlers().addHandler(MaxSelectedEvent.getType(),
                handler);
    }

    public HandlerRegistration addReadyHandler(ReadyHandler handler) {
        return ensureChosenHandlers().addHandler(ReadyEvent.getType(), handler);
    }

    public HandlerRegistration addShowingDropDownHandler(
            ShowingDropDownHandler handler) {
        return ensureChosenHandlers().addHandler(
                ShowingDropDownEvent.getType(), handler);
    }

    /**
     * Appends an item to the end of the list, adding the supplied class name to its class attribute. Equivalent to
     * calling {@code addStyledItem(label, value, className, 0)}.
     *
     * @param label     the item label to display to the user
     * @param value     the value of the item, meaningful in the context of an HTML form
     * @param className the class name to add to this item (pass {@code null} to add no class name)
     * @see #addStyledItem(String, String, String, int)
     */
    public void addStyledItem(String label, String value, String className) {
        addStyledItem(label, value, className, 0);
    }

    /**
     * Appends an item to the end of the list, adding the supplied class name to its class attribute. Specifying a
     * non-zero {@code indentLevel} will pad the item from the left by a fixed distance applied {@code indentLevel}
     * times.
     * 

     * For example, a call:
     * 

     * {@code
     * addStyledItem("My Item", "item1", "highlighted", 1);
     * }
     * 

     * will result in the addition to the end of the {@code } element of:
     * 

     * {@code
     * 
My Item
     * }
     *
     * @param label       the item label to display to the user
     * @param value       the value of the item, meaningful in the context of an HTML form
     * @param className   the class name to add to this item (pass {@code null} to add no class name)
     * @param indentLevel the number of times to indent the item from the left (pass 0 for no indentation)
     */
    public void addStyledItem(String label, String value, String className, int indentLevel) {
        if (indentLevel < 0) {
            throw new IllegalArgumentException("[indentLevel] must be non-negative.");
        }
        GQuery $selectElem = $(getElement());
        OptionElement option = Document.get().createOptionElement();
        option.setValue(value);
        option.setText(label);
        if (!(className == null || className.trim().isEmpty())) {
            option.addClassName(className);
        }
        if (indentLevel > 0) {
            int leftPadding = options.getResources().css().indent() * indentLevel;
            option.setAttribute("style", "padding-left: " + leftPadding + "px;");
        }
        $selectElem.append(option);
    }

    /**
     * Adds an item to the group specified by its index.
     *
     * @param label      the item label to display to the user
     * @param value      the value of the item, meaningful in the context of an HTML form
     * @param className  the class name to add to this item (pass {@code null} to add no class name)
     * @param groupIndex index of the group to add the item to
     */
    public void addStyledItemToGroup(String label, String value, String className, int groupIndex) {
        addStyledItemToGroup(label, value, className, 0, groupIndex);
    }

    /**
     * @param label       the item label to display to the user
     * @param value       the value of the item, meaningful in the context of an HTML form
     * @param className   the class name to add to this item (pass {@code null} to add no class name)
     * @param indentLevel the number of times to indent the item from the left (pass 0 for no indentation)
     * @param groupIndex  the index of the optGroup where the item will be inserted
     */
    public void addStyledItemToGroup(String label, String value, String className, int indentLevel, int groupIndex) {
        insertStyledItemToGroup(label, value, className, null /* dir */, indentLevel, groupIndex, -1);
    }

    public HandlerRegistration addUpdatedHandler(UpdatedHandler handler) {
        return ensureChosenHandlers().addHandler(
                UpdatedEvent.getType(), handler);
    }

    @Override
    public void clear() {
        clear(true);
    }

    public void clear(boolean update) {
        $(getElement()).html("");
        if (update) {
            update();
        }
    }

    public void forceRedraw() {
        $(getElement()).as(Chosen).destroy()
                .chosen(options, ensureChosenHandlers());
    }

    public GQuery getChosenElement() {
        ChosenImpl impl = $(getElement()).data(CHOSEN_DATA_KEY,
                ChosenImpl.class);
        if (impl != null) {
            return impl.getContainer();
        }
        return $();
    }

    public int getDisableSearchThreshold() {
        return options.getDisableSearchThreshold();
    }

    public void setDisableSearchThreshold(int disableSearchThreshold) {
        options.setDisableSearchThreshold(disableSearchThreshold);
    }

    public int getMaxSelectedOptions() {
        return options.getMaxSelectedOptions();
    }

    public void setMaxSelectedOptions(int maxSelectedOptions) {
        options.setMaxSelectedOptions(maxSelectedOptions);
    }

    public String getNoResultsText() {
        return options.getNoResultsText();
    }

    public void setNoResultsText(String noResultsText) {
        options.setNoResultsText(noResultsText);
    }

    public String getPlaceholderText() {
        return options.getPlaceholderText();
    }

    public void setPlaceholderText(String placeholderText) {
        options.setPlaceholderText(placeholderText);
    }

    public String getPlaceholderTextMultiple() {
        return options.getPlaceholderTextMultiple();
    }

    public void setPlaceholderTextMultiple(String placeholderTextMultiple) {
        options.setPlaceholderTextMultiple(placeholderTextMultiple);
    }

    public String getPlaceholderTextSingle() {
        return options.getPlaceholderTextSingle();
    }

    public void setPlaceholderTextSingle(String placeholderTextSingle) {
        options.setPlaceholderTextSingle(placeholderTextSingle);
    }

    /**
     * Return the value of the first selected option if any. Returns false otherwise.
     * In case of multiple ChosenListBox, please use {@link #getValues()} instead.
     *
     * @return the value of the first selected option if any
     */
    public String getValue() {
        String[] values = getValues();

        return values != null && values.length > 0 ? values[0] : null;
    }

    /**
     * Return the values of all selected options in an array.
     * Usefull to know which options are selected in case of multiple ChosenListBox
     *
     * @return the values of all selected options in an array
     */
    public String[] getValues() {
        ChosenImpl impl = $(getElement()).data(CHOSEN_DATA_KEY, ChosenImpl.class);

        if (impl != null) {
            List selectedValues = impl.getSelectedValues();
            return selectedValues.toArray(new String[selectedValues.size()]);
        } else {
            JsArrayString values = JsArrayString.createArray().cast();
            NodeList options = SelectElement.as(getElement()).getOptions();
            for (int i = 0; i < options.getLength(); i++) {
                OptionElement option = options.getItem(i);
                if (option.isSelected()) {
                    values.push(option.getValue());
                }
            }

            String[] result = new String[values.length()];
            for (int i = 0; i < values.length(); i++) {
                result[i] = values.get(i);
            }

            return result;
        }
    }

    /**
     * Insert a group to the list box.
     *
     * @param label the text of the group to be added
     * @param index the index at which to insert it
     */
    public void insertGroup(String label, int index) {
        insertGroup(label, null, index);
    }

    /**
     * Insert a group to the list box.
     *
     * @param label the text of the group to be added
     * @param id    the id of the optgroup element
     * @param index the index at which to insert it
     */
    public void insertGroup(String label, String id, int index) {
        GQuery optGroup = $("").attr("label", label);
        if (id != null) {
            optGroup.attr("id", id);
        }
        GQuery select = $(getElement());

        int itemCount = SelectElement.as(getElement()).getLength();

        if (index < 0 || index > itemCount) {
            select.append(optGroup);
        } else {
            GQuery before = select.children().eq(index);
            before.before(optGroup);
        }
    }

    /**
     * Adds an item to the an optgroup of the list box. If no optgroup exists,
     * the item will be add at the end ot the list box.
     *
     * @param item       the text of the item to be added
     * @param value      the value of the item to be added
     * @param itemIndex  the index inside the optgroup at which to insert the item
     * @param groupIndex the index of the optGroup where the item will be inserted
     */
    public void insertItemToGroup(String item, Direction dir, String value, int groupIndex, int itemIndex) {
        insertStyledItemToGroup(item, value, null /* className */, dir, 0, groupIndex, itemIndex);
    }

    /**
     * Adds an item to the an optgroup of the list box. If no optgroup exists,
     * the item will be add at the end ot the list box.
     *
     * @param item       the text of the item to be added
     * @param itemIndex  the index inside the optgroup at which to insert the item
     * @param groupIndex the index of the optGroup where the item will be inserted
     */
    public void insertItemToGroup(String item, int groupIndex, int itemIndex) {
        insertItemToGroup(item, null, item, groupIndex, itemIndex);
    }

    /**
     * Adds an item to the an optgroup of the list box. If no optgroup exists,
     * the item will be add at the end ot the list box.
     *
     * @param item       the text of the item to be added
     * @param value      the value of the item to be added
     * @param itemIndex  the index inside the optgroup at which to insert the item
     * @param groupIndex the index of the optGroup where the item will be inserted
     */
    public void insertItemToGroup(
            String item, String value, int groupIndex,
            int itemIndex) {
        insertItemToGroup(item, null, value, groupIndex, itemIndex);
    }

    /**
     * @param item       the item label to display to the user
     * @param value      the value of the item, meaningful in the context of an HTML form
     * @param className  the class name to add to this item (pass {@code null} to add no class name)
     * @param groupIndex the index of the optgroup where the item will be inserted
     * @param itemIndex  the index inside the optgroup at which to insert the item
     */
    public void insertStyledItemToGroup(String item, String value, String className, int groupIndex, int itemIndex) {
        insertStyledItemToGroup(item, value, className, 0, groupIndex, itemIndex);
    }

    /**
     * @param item        the item label to display to the user
     * @param value       the value of the item, meaningful in the context of an HTML form
     * @param className   the class name to add to this item (pass {@code null} to add no class name)
     * @param indentLevel the number of times to indent the item from the left (pass 0 for no indentation)
     * @param groupIndex  the index of the optgroup where the item will be inserted
     * @param itemIndex   the index inside the optgroup at which to insert the item
     */
    public void insertStyledItemToGroup(
            String item, String value, String className, int indentLevel, int groupIndex,
            int itemIndex) {
        insertStyledItemToGroup(item, value, className, null /* dir */, indentLevel, groupIndex, itemIndex);
    }

    /**
     * Inserts an item into a group at the specified location. Additionally, the item can have an extra class name as
     * well as indent level assigned to it.
     * 

     * NB! It is important to set text into the option after the option has been appended to the DOM
     * 
that's known bug in IE  @see jQuery bug tracker
     * 

     *
     * @param item        the item label to display
     * @param value       the value of the item in the HTML form context
     * @param className   the class name to append to the option (pass {@code null} to append no class name)
     * @param dir         allows specifying an RTL, LTR or inherited direction ({@code null} is LTR)
     * @param indentLevel the number of times to indent the item from the left (pass 0 for no indentation)
     * @param groupIndex  the index of the group to insert the item into (if out of bounds, the last group will be used)
     * @param itemIndex   the index of the item within a group (if out of bounds, item will be placed last in the group)
     */
    public void insertStyledItemToGroup(
            String item, String value, String className, Direction dir, int indentLevel,
            int groupIndex, int itemIndex) {
        int pos = groupIndex;
        if (indentLevel < 0) {
            throw new IllegalArgumentException("[indentLevel] must be non-negative.");
        }
        GQuery optgroupList = $(OPTGROUP_TAG, getElement());

        int groupCount = optgroupList.size();

        if (groupCount == 0) {
            // simply insert the item to the listbox
            insertItem(item, dir, value, itemIndex);
            return;
        }

        if (pos < 0 || pos > groupCount - 1) {
            pos = groupCount - 1;
        }

        GQuery optgroup = optgroupList.eq(pos);

        OptionElement option = Document.get().createOptionElement();

        if (!(className == null || className.trim().isEmpty())) {
            option.addClassName(className);
        }
        if (indentLevel > 0) {
            // Calculate total indentation, not forgetting that being in a group is adding one extra indent step
            int leftPadding = options.getResources().css().indent() * (indentLevel + 1);
            option.setAttribute("style", "padding-left: " + leftPadding + "px;");
        }

        Element optGroupElement = optgroup.get(0);
        int itemCount = optGroupElement.getChildCount();

        if (itemIndex < 0 || itemIndex > itemCount - 1) {
            optgroup.append(option);
        } else {
            GQuery before = $(optGroupElement.getChild(itemIndex));
            before.before(option);
        }
        // setText must be after the element has been appended to the DOM - see javadoc
        setOptionText(option, item, dir);
        option.setValue(value);
    }

    /**
     * Specify if the deselection is allowed on single selects.
     */
    public boolean isAllowSingleDeselect() {
        return options.isAllowSingleDeselect();
    }

    public void setAllowSingleDeselect(boolean allowSingleDeselect) {
        options.setAllowSingleDeselect(allowSingleDeselect);
    }

    public boolean isSearchContains() {
        return options.isSearchContains();
    }

    public void setSearchContains(boolean searchContains) {
        options.setSearchContains(searchContains);
    }

    public boolean isSingleBackstrokeDelete() {
        return options.isSingleBackstrokeDelete();
    }

    public void setSingleBackstrokeDelete(boolean singleBackstrokeDelete) {
        options.setSingleBackstrokeDelete(singleBackstrokeDelete);
    }

    public void removeGroup(int index) {
        $(OPTGROUP_TAG, getElement()).eq(index).remove();
        update();
    }

    /**
     * Remove the optgroup (and the children options) by id.
     * To set an id to an optgroup, use {@link #insertGroup(String, String, int)} or {@link #addGroup(String, String)}
     *
     * @param id the id of the group to remove
     */
    public void removeGroupById(String id) {
        $("#" + id, getElement()).remove();
        update();
    }

    /**
     * Remove all optgroup (and the children options) with a label matching label argument.
     */
    public void removeGroupByLabel(String label) {
        $(OPTGROUP_TAG + "[label='" + label + "']", getElement()).remove();
        update();
    }

    @Override
    public void setEnabled(boolean enabled) {
        super.setEnabled(enabled);

        update();
    }

    @Override
    public void setFocus(boolean focused) {
        GQuery focusElement = getFocusableElement();
        if (focused) {
            focusElement.focus();
        } else {
            focusElement.blur();
        }
    }

    public void setHighlightSearchTerm(boolean highlightSearchTerm) {
        options.setHighlightSearchTerm(highlightSearchTerm);
    }

    @Override
    public void setItemSelected(int index, boolean selected) {
        super.setItemSelected(index, selected);
        update();
    }

    @Override
    public void setSelectedIndex(int index) {
        super.setSelectedIndex(index);
        update();
    }

    /**
     * Select all options with value present in values array and update the component.
     *
     * @param values the values to select
     */
    public void setSelectedValue(String... values) {
        for (String value : values) {
            Element element = $("option[value='" + value + "']", this).get(0);

            if (element != null) {
                OptionElement.as(element).setSelected(true);
            }
        }
        update();
    }

    @Override
    public void setVisible(boolean visible) {
        this.visible = visible;

        GQuery chosenElement = getChosenElement();

        if (visible) {
            chosenElement.show();
        } else {
            chosenElement.hide();
        }
    }

    /**
     * Unselect all previously selected values.
     */
    public void unselectAll() {
        for (Element selected : $("option:selected", this).elements()) {
            OptionElement.as(selected).setSelected(false);
        }
    }

    /**
     * Use this method to update the chosen list box (i.e. after insertion or
     * removal of options)
     */
    public void update() {
        ensureChosenHandlers().fireEvent(new UpdatedEvent());
    }

    protected final  HandlerRegistration addChosenHandler(
            H handler, Type type) {
        return ensureChosenHandlers().addHandler(type, handler);
    }

    protected EventBus ensureChosenHandlers() {
        return chznHandlerManager == null ? chznHandlerManager = new SimpleEventBus()
                : chznHandlerManager;
    }

    protected EventBus getChosenHandlerManager() {
        return chznHandlerManager;
    }

    @Override
    protected com.google.gwt.user.client.Element getStyleElement() {
        GQuery chosenElement = getChosenElement();
        if (!chosenElement.isEmpty()) {
            return chosenElement.get(0).cast();
        }

        return super.getStyleElement();
    }

    @Override
    protected void onLoad() {
        super.onLoad();
        $(getElement()).as(Chosen).chosen(options, ensureChosenHandlers());
        setVisible(visible);
    }

    @Override
    protected void onUnload() {
        super.onUnload();
        $(getElement()).as(Chosen).destroy();
    }

    private GQuery getFocusableElement() {
        GQuery chosen = getChosenElement();
        GQuery focusableElement = chosen.children("a");
        if (focusableElement.isEmpty()) {
            focusableElement = chosen.find("input");
        }

        return focusableElement;
    }
}
 













© 2015 - 2024 Weber Informatics LLC | Privacy Policy