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 format the text displayed when selectedTextFormat
025 * is <code>count</code> or <code>count > #</code>.<br>
026 * <br>
027 * Defaults to: <code>X of Y selected</code>
028 *
029 * @author Xiaodong Sun
030 */
031public interface CountSelectedTextHandler {
032
033    /**
034     * Returns the text displayed when selectedTextFormat
035     * is <code>count</code> or <code>count > #</code>.
036     *
037     * @param selectedCount number of the selected options
038     * @param totalCount total number of options
039     * @return the text displayed when selectedTextFormat
040     *     is <code>count</code> or <code>count > #</code>
041     */
042    String getCountSelectedText(int selectedCount, int totalCount);
043
044}