org.wicketstuff.kendo.ui.widget.window.WindowButton Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of wicketstuff-kendo-ui Show documentation
Wicket-Kendo UI
There is a newer version: 10.3.0
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 org.wicketstuff.kendo.ui.widget.window;

import org.apache.wicket.markup.html.form.IFormSubmittingComponent;
import org.apache.wicket.model.IModel;
import org.apache.wicket.model.Model;
import org.apache.wicket.util.io.IClusterable;
import org.apache.wicket.util.string.Strings;
import org.wicketstuff.kendo.ui.KendoIcon;

/**
 * Provides the button object that can be used in {@link MessageWindow}
 *
 * @author Sebastien Briquet - sebfz1
 */
public class WindowButton implements IClusterable
{
	private static final long serialVersionUID = 1L;

	/** default icon */
	private static final String ICON = KendoIcon.NONE;

	/**
	 * Helper that creates a new {@link WindowButton}
	 *
	 * @param name the button's name
	 * @param model the button's text
	 * @param formProcessing whether the form will be validated and updated
	 * @return a new {@code WindowButton}
	 */
	public static WindowButton of(String name, IModel model, boolean formProcessing)
	{
		return WindowButton.of(name, model, ICON, formProcessing);
	}

	/**
	 * Helper that creates a new {@link WindowButton}
	 *
	 * @param name the button's name
	 * @param model the button's text
	 * @param icon the button's icon
	 * @param formProcessing whether the form will be validated and updated
	 * @return a new {@code WindowButton}
	 */
	public static WindowButton of(String name, IModel model, String icon, boolean formProcessing)
	{
		WindowButton button = new WindowButton(name, model, icon);

		return button.setDefaultFormProcessing(formProcessing);
	}

	private String name;
	private String icon;
	private boolean enabled;
	private boolean visible = true;
	private boolean formProcessing = true;

	private final IModel model;

	/**
	 * Constructor
	 * 
	 * @param name the button's name
	 * @param text the button's text
	 */
	public WindowButton(String name, String text)
	{
		this(name, Model.of(text), ICON, true);
	}

	/**
	 * Constructor
	 *
	 * @param name the button's name
	 * @param text the button's text
	 * @param icon the button's icon
	 */
	public WindowButton(String name, String text, String icon)
	{
		this(name, Model.of(text), icon, true);
	}

	/**
	 * Constructor
	 *
	 * @param name the button's name
	 * @param text the button's text
	 * @param enabled indicates whether the button is enabled
	 */
	public WindowButton(String name, String text, boolean enabled)
	{
		this(name, Model.of(text), ICON, enabled);
	}

	/**
	 * Constructor
	 *
	 * @param name the button's name
	 * @param text the button's text
	 * @param icon the button's icon
	 * @param enabled indicates whether the button is enabled
	 */
	public WindowButton(String name, String text, String icon, boolean enabled)
	{
		this(name, Model.of(text), icon, enabled);
	}

	/**
	 * Constructor
	 *
	 * @param name the button's name
	 * @param model the button's text
	 */
	public WindowButton(String name, IModel model)
	{
		this(name, model, ICON, true);
	}

	/**
	 * Constructor
	 *
	 * @param name the button's name
	 * @param model the button's text
	 * @param icon the button's icon
	 */
	public WindowButton(String name, IModel model, String icon)
	{
		this(name, model, icon, true);
	}

	/**
	 * Constructor
	 *
	 * @param name the button's name
	 * @param model the button's text
	 * @param enabled indicates whether the button is enabled
	 */
	public WindowButton(String name, IModel model, boolean enabled)
	{
		this(name, model, ICON, enabled);
	}

	/**
	 * Main constructor
	 *
	 * @param name the button's name
	 * @param model the button's text
	 * @param icon the button's icon
	 * @param enabled indicates whether the button is enabled
	 */
	public WindowButton(String name, IModel model, String icon, boolean enabled)
	{
		this.name = name;
		this.model = model;
		this.icon = icon;
		this.enabled = enabled;
	}

	// Properties //

	/**
	 * Gets the button's name
	 *
	 * @return the button's name
	 */
	public String getName()
	{
		return this.name;
	}

	/**
	 * INTERNAL USE

	 * Gets the model of the button's text

	 * 

	 * Warning: it may throw an Exception if not wrapped to a component
	 *
	 * @return the {@link IModel}
	 */
	IModel getModel()
	{
		return this.model;
	}

	/**
	 * Gets the button's icon
	 *
	 * @return the button's icon
	 */
	public String getIcon()
	{
		return this.icon;
	}

	/**
	 * Sets the button's icon
	 *
	 * @param icon the css class (ie: k-i-icon)
	 */
	public void setIcon(String icon)
	{
		this.icon = icon;
	}

	/**
	 * Indicates whether the button is enabled
	 *
	 * @return true or false
	 */
	public boolean isEnabled()
	{
		return this.enabled;
	}

	// TODO: #setEnabled(boolean enabled, IPartialPageRequestHandler handler)

	/**
	 * Indicates whether the button is visible
	 *
	 * @return true or false
	 */
	public boolean isVisible()
	{
		return this.visible;
	}

	// TODO: #setVisible(boolean visible, AjaxRequestTarget target)

	/**
	 * Indicates whether the button has a busy indicator
	 * 
	 * @return {@link #getDefaultFormProcessing()} by default
	 */
	public boolean isIndicating()
	{
		return this.getDefaultFormProcessing();
	}

	/**
	 * Indicates whether the form will be validated and updated.
	 *
	 * @return true by default
	 * @see IFormSubmittingComponent#getDefaultFormProcessing()
	 */
	public boolean getDefaultFormProcessing()
	{
		return this.formProcessing;
	}

	/**
	 * Set the default form processing
	 *
	 * @param processing true or false
	 * @return this, for chaining
	 */
	public WindowButton setDefaultFormProcessing(boolean processing)
	{
		this.formProcessing = processing;

		return this;
	}

	// Methods //

	/**
	 * Indicates whether this {@link WindowButton} is equal to another {@link WindowButton}.

	 * Are considered equals buttons having the same text representation, which is the text supplied to the constructor (if {@link #toString()} is not overridden).
	 *
	 * @param object the {@link WindowButton} to compare to
	 * @return true if considered as equal
	 */
	@Override
	public boolean equals(Object object)
	{
		if (object instanceof WindowButton)
		{
			return this.match(((WindowButton) object).getName());
		}

		return super.equals(object);
	}

	@Override
	public int hashCode()
	{
		return this.name.hashCode();
	}

	/**
	 * Indicates whether this {@link WindowButton} name match the supplied name.
	 *
	 * @param name the name to compare to
	 * @return true if equal
	 */
	public boolean match(String name)
	{
		return Strings.isEqual(name, this.name);
	}

	@Override
	public String toString()
	{
		return this.name;
	}
}