org.wicketstuff.kendo.ui.datatable.column.CommandColumn 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.datatable.column;

import java.util.List;

import org.apache.wicket.model.IModel;
import org.wicketstuff.kendo.ui.datatable.DataTable;
import org.wicketstuff.kendo.ui.datatable.button.CommandButton;

/**
 * Provides a commands column for a {@link DataTable}
 *
 * @author Sebastien Briquet - sebfz1
 */
public abstract class CommandColumn extends AbstractColumn
{
	private static final long serialVersionUID = 1L;

	private List buttons = null;

	/**
	 * Constructor
	 */
	protected CommandColumn()
	{
		super("");
	}

	/**
	 * Constructor
	 * 
	 * @param title the text of the column header
	 */
	protected CommandColumn(String title)
	{
		super(title);
	}

	/**
	 * Constructor
	 * 
	 * @param width the desired width of the column
	 */
	protected CommandColumn(int width)
	{
		super("", width);
	}

	/**
	 * Constructor
	 * 
	 * @param title the text of the column header
	 * @param width the desired width of the column
	 */
	protected CommandColumn(String title, int width)
	{
		super(title, width);
	}

	/**
	 * Constructor
	 * 
	 * @param title the text of the column header
	 */
	protected CommandColumn(IModel title)
	{
		super(title);
	}

	/**
	 * Constructor
	 * 
	 * @param title the text of the column header
	 * @param width the desired width of the column
	 */
	protected CommandColumn(IModel title, int width)
	{
		super(title, width);
	}

	/**
	 * Gets a new {@link List} a {@link CommandButton}
	 *
	 * @return a new {@code List} a {@link CommandButton}
	 */
	protected abstract List newButtons();

	/**
	 * Gets the list of {@link CommandButton}
	 *
	 * @return the list of {@link CommandButton}
	 */
	public final synchronized List getButtons()
	{
		if (this.buttons == null)
		{
			this.buttons = this.newButtons();
		}

		return this.buttons;
	}

	// statics //

	/**
	 * Factory method
	 * 
	 * @param buttons the list of buttons
	 * @return a new {@link CommandColumn}
	 * @see #newButtons()
	 */
	public static CommandColumn of(final List buttons)
	{
		return new CommandColumn() {

			private static final long serialVersionUID = 1L;

			@Override
			protected List newButtons()
			{
				return buttons;
			}
		};
	}

	/**
	 * Factory method
	 * 
	 * @param title the text of the column header
	 * @param buttons the list of buttons
	 * @return a new {@link CommandColumn}
	 * @see #newButtons()
	 */
	public static CommandColumn of(String title, final List buttons)
	{
		return new CommandColumn(title) {

			private static final long serialVersionUID = 1L;

			@Override
			protected List newButtons()
			{
				return buttons;
			}
		};
	}

	/**
	 * Factory method
	 * 
	 * @param width the desired width of the column
	 * @param buttons the list of buttons
	 * @return a new {@link CommandColumn}
	 * @see #newButtons()
	 */
	public static CommandColumn of(int width, final List buttons)
	{
		return new CommandColumn(width) {

			private static final long serialVersionUID = 1L;

			@Override
			protected List newButtons()
			{
				return buttons;
			}
		};
	}

	/**
	 * Factory method
	 * 
	 * @param title the text of the column header
	 * @param width the desired width of the column
	 * @param buttons the list of buttons
	 * @return a new {@link CommandColumn}
	 * @see #newButtons()
	 */
	public static CommandColumn of(String title, int width, final List buttons)
	{
		return new CommandColumn(title, width) {

			private static final long serialVersionUID = 1L;

			@Override
			protected List newButtons()
			{
				return buttons;
			}
		};
	}

	/**
	 * Factory method
	 * 
	 * @param title the text of the column header
	 * @param buttons the list of buttons
	 * @return a new {@link CommandColumn}
	 * @see #newButtons()
	 */
	public static CommandColumn of(IModel title, final List buttons)
	{
		return new CommandColumn(title) {

			private static final long serialVersionUID = 1L;

			@Override
			protected List newButtons()
			{
				return buttons;
			}
		};
	}

	/**
	 * Factory method
	 * 
	 * @param title the text of the column header
	 * @param width the desired width of the column
	 * @param buttons the list of buttons
	 * @return a new {@link CommandColumn}
	 * @see #newButtons()
	 */
	public static CommandColumn of(IModel title, int width, final List buttons)
	{
		return new CommandColumn(title, width) {

			private static final long serialVersionUID = 1L;

			@Override
			protected List newButtons()
			{
				return buttons;
			}
		};
	}
}