001package org.gwtbootstrap3.extras.select.client.ui;
002
003/*
004 * #%L
005 * GwtBootstrap3
006 * %%
007 * Copyright (C) 2013 - 2016 GwtBootstrap3
008 * %%
009 * Licensed under the Apache License, Version 2.0 (the "License");
010 * you may not use this file except in compliance with the License.
011 * You may obtain a copy of the License at
012 * 
013 *      http://www.apache.org/licenses/LICENSE-2.0
014 * 
015 * Unless required by applicable law or agreed to in writing, software
016 * distributed under the License is distributed on an "AS IS" BASIS,
017 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
018 * See the License for the specific language governing permissions and
019 * limitations under the License.
020 * #L%
021 */
022
023/**
024 * Handler to set the text displayed when {@link SelectOptions#MAX_OPTIONS}
025 * is enabled and the maximum number of options within the entire select or
026 * an option group have been selected.
027 *
028 * @author Xiaodong Sun
029 */
030public interface MaxOptionsTextHandler {
031
032    /**
033     * Returns the text displayed when {@link SelectOptions#MAX_OPTIONS}
034     * is enabled and the maximum number of options within the select
035     * have been selected<br>
036     * <br>
037     * Defaults to <code>Limit reached ({n} item(s) max)</code>
038     *
039     * @param maxOptions maximum number of the select
040     * @return the text displayed when the maximum number of
041     *     options within the select have been selected
042     */
043    String getMaxSelectOptionsText(int maxSelectOptions);
044
045    /**
046     * Returns the text displayed when {@link SelectOptions#MAX_OPTIONS}
047     * is enabled and the maximum number of options within an option
048     * group have been selected<br>
049     * <br>
050     * Defaults to <code>Group limit reached ({n} item(s) max)</code>
051     *
052     * @param maxGroupOptions maximum number of an option group
053     * @return the text displayed when the maximum number of options
054     *     within an option group have been selected
055     */
056    String getMaxGroupOptionsText(int maxGroupOptions);
057
058}