/*
 * Copyright 2026, Stefan Uebe
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
 * documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all copies or substantial portions
 * of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
 * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */
package org.vaadin.stefan.fullcalendar;

/**
 * Whether the buttons of the built-in toolbar show an icon, text or both. Corresponds to the FullCalendar
 * {@code buttonDisplay} option and to the {@code display} property of a single button in {@link Option#BUTTONS}.
 * <p>
 * The values only affect FullCalendar's built-in header and footer toolbar, not a Vaadin component. The add-on hides
 * the header toolbar by default, and FullCalendar shows no footer toolbar by default. Setting
 * {@link Option#HEADER_TOOLBAR} or {@link Option#FOOTER_TOOLBAR} shows the respective toolbar.
 *
 * @see <a href="https://fullcalendar.io/docs/buttonDisplay">buttonDisplay</a>
 */
public enum NativeToolbarButtonDisplay implements ClientSideValue {
    /** The icon, if the theme supplies one for the button, otherwise the text (default). */
    AUTO("auto"),
    /** Only the icon. */
    ICON("icon"),
    /** Only the text. */
    TEXT("text"),
    /** The icon followed by the text. */
    ICON_TEXT("icon-text"),
    /** The text followed by the icon. */
    TEXT_ICON("text-icon");

    private final String clientSideValue;

    NativeToolbarButtonDisplay(String clientSideValue) {
        this.clientSideValue = clientSideValue;
    }

    @Override
    public String getClientSideValue() {
        return clientSideValue;
    }
}