org.wicketstuff.kendo.ui.widget.window.AbstractWindow 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.ajax.AjaxRequestTarget;
import org.apache.wicket.core.request.handler.IPartialPageRequestHandler;
import org.apache.wicket.markup.html.panel.GenericPanel;
import org.apache.wicket.model.IModel;
import org.apache.wicket.model.Model;
import org.apache.wicket.util.lang.Args;
import org.wicketstuff.jquery.core.IJQueryWidget;
import org.wicketstuff.jquery.core.JQueryBehavior;
import org.wicketstuff.jquery.core.Options;
import org.wicketstuff.kendo.ui.KendoUIBehavior;

/**
 * Base class for implementing Kendo UI windows
 *
 * @param  the type of the model object
 *
 * @author Sebastien Briquet - sebfz1
 * @since 6.17.0
 */
public abstract class AbstractWindow extends GenericPanel implements IJQueryWidget, IWindowListener // NOSONAR
{
	private static final long serialVersionUID = 1L;

	protected static final String ACTION_PIN = "pin";
	protected static final String ACTION_CLOSE = "close";
	protected static final String ACTION_REFRESH = "refresh";
	protected static final String ACTION_CUSTOM = "custom";
	protected static final String ACTION_MINIMIZE = "minimize";
	protected static final String ACTION_MAXIMIZE = "maximize";

	/** Default width */
	private static final int WIDTH = 450;

	private IModel titleModel;
	private boolean modal;
	
	/** widget behavior */
	private WindowBehavior widgetBehavior = null;

	/**
	 * Constructor
	 *
	 * @param id the markup id, an html div suffice to host a window.
	 * @param title the title of the window
	 */
	public AbstractWindow(String id, String title)
	{
		this(id, title, null, true);
	}

	/**
	 * Constructor
	 *
	 * @param id the markup id, an html div suffice to host a window.
	 * @param title the title of the window
	 */
	public AbstractWindow(String id, IModel title)
	{
		this(id, title, null, true);
	}

	/**
	 * Constructor
	 *
	 * @param id the markup id, an html div suffice to host a window.
	 * @param title the title of the window
	 * @param model the model to be used in the window.
	 */
	public AbstractWindow(String id, String title, IModel model)
	{
		this(id, title, model, true);
	}

	/**
	 * Constructor
	 *
	 * @param id the markup id, an html div suffice to host a window.
	 * @param title the title of the window
	 * @param model the model to be used in the window.
	 */
	public AbstractWindow(String id, IModel title, IModel model)
	{
		this(id, title, model, true);
	}

	/**
	 * Constructor
	 *
	 * @param id the markup id, an html div suffice to host a window.
	 * @param title the title of the window
	 * @param modal indicates whether the window is modal
	 */
	public AbstractWindow(String id, String title, boolean modal)
	{
		this(id, title, null, modal);
	}

	/**
	 * Constructor
	 *
	 * @param id the markup id, an html div suffice to host a window.
	 * @param title the title of the window
	 * @param modal indicates whether the window is modal
	 */
	public AbstractWindow(String id, IModel title, boolean modal)
	{
		this(id, title, null, modal);
	}

	/**
	 * Constructor
	 *
	 * @param id the markup id, an html div suffice to host a window.
	 * @param title the title of the window
	 * @param modal indicates whether the window is modal
	 * @param model the model to be used in the window
	 */
	public AbstractWindow(String id, String title, IModel model, boolean modal)
	{
		this(id, Model.of(title), model, modal);
	}

	/**
	 * Constructor
	 *
	 * @param id the markup id, an html div suffice to host a window.
	 * @param title the title of the window
	 * @param modal indicates whether the window is modal
	 * @param model the model to be used in the window
	 */
	public AbstractWindow(String id, IModel title, IModel model, boolean modal)
	{
		super(id, model);

		this.titleModel = title;
		this.modal = modal;
	}

	// Methods //

	/**
	 * Gets the Kendo UI widget
	 *
	 * @return the jQuery object
	 */
	public String widget()
	{
		return KendoUIBehavior.widget(this, WindowBehavior.METHOD);
	}

	/**
	 * Opens the window in ajax.
	 *
	 * @param handler the {@link IPartialPageRequestHandler}
	 */
	public final void open(IPartialPageRequestHandler handler)
	{
		this.onOpen(handler);

		if (this.widgetBehavior != null)
		{
			this.widgetBehavior.open(handler);
		}
	}

	/**
	 * Closes the window in ajax.
	 *
	 * @param handler the {@link IPartialPageRequestHandler}
	 */
	public final void close(IPartialPageRequestHandler handler)
	{
		if (this.widgetBehavior != null)
		{
			this.widgetBehavior.close(handler);
		}

		this.onClose(handler);
	}

	// Properties //

	/**
	 * Gets the window's with
	 *
	 * @return {@link #WIDTH} by default
	 */
	public int getWidth()
	{
		return AbstractWindow.WIDTH;
	}

	/**
	 * Gets the window's title
	 *
	 * @return the window's title
	 */
	public String getTitle()
	{
		return this.titleModel.getObject();
	}

	/**
	 * Sets the window's title
	 *
	 * @param title the window's title
	 */
	public void setTitle(String title)
	{
		this.titleModel.setObject(title);
	}

	/**
	 * Sets the window's title dynamically
	 *
	 * @param handler the {@link IPartialPageRequestHandler}
	 * @param title the window's title
	 */
	public void setTitle(IPartialPageRequestHandler handler, String title)
	{
		this.setTitle(title);

		handler.appendJavaScript(String.format("%s.title(%s);", this.widgetBehavior.widget(), Options.asString(title)));
	}

	/**
	 * Gets the window's title
	 *
	 * @return the window's title
	 */
	public IModel getTitleModel()
	{
		return this.titleModel;
	}

	/**
	 * Sets the window's title
	 *
	 * @param model the window's title
	 */
	public void setTitleModel(IModel model)
	{
		Args.notNull(model, "model");

		this.titleModel = model;
	}

	/**
	 * Sets the window's title dynamically
	 *
	 * @param handler the {@link IPartialPageRequestHandler}
	 * @param model the window's title
	 */
	public void setTitleModel(IPartialPageRequestHandler handler, IModel model)
	{
		this.setTitleModel(model);

		handler.appendJavaScript(String.format("%s.title(%s);", this.widgetBehavior.widget(), Options.asString(model.getObject())));
	}

	/**
	 * Gets the modal flag
	 *
	 * @return the modal flag supplied to the constructor by default
	 */
	public final boolean isModal()
	{
		return this.modal;
	}

	/**
	 * Indicates whether the window is centered
	 *
	 * @return {@code true }by default
	 */
	public boolean isCentered()
	{
		return true;
	}

	/**
	 * Indicates whether the window is resizable
	 *
	 * @return {@code false} by default
	 * @see WindowBehavior#isCentered()
	 */
	public boolean isResizable()
	{
		return false;
	}

	@Override
	public boolean isActionEventEnabled()
	{
		return false;
	}

	@Override
	public boolean isCloseEventEnabled()
	{
		return false;
	}

	// Events //

	@Override
	protected void onInitialize()
	{
		super.onInitialize();

		this.widgetBehavior = (WindowBehavior) JQueryWidget.newWidgetBehavior(this);
		this.add(this.widgetBehavior);
	}

	@Override
	public void onConfigure(JQueryBehavior behavior)
	{
		// class options //
		behavior.setOption("title", Options.asString(this.getTitle()));
		behavior.setOption("modal", this.isModal());
		behavior.setOption("resizable", this.isResizable());
		behavior.setOption("width", this.getWidth());
		behavior.setOption("visible", false);
	}

	@Override
	public void onBeforeRender(JQueryBehavior behavior)
	{
		// noop
	}

	/**
	 * Triggered when the window opens
	 *
	 * @param handler the {@link IPartialPageRequestHandler}
	 */
	protected void onOpen(IPartialPageRequestHandler handler)
	{
		// noop
	}

	@Override
	public void onAction(AjaxRequestTarget target, String action)
	{
		// noop
	}

	@Override
	public void onClose(IPartialPageRequestHandler handler)
	{
		// noop
	}

	// IJQueryWidget //

	/**
	 * @see IJQueryWidget#newWidgetBehavior(String)
	 */
	@Override
	public WindowBehavior newWidgetBehavior(String selector)
	{
		return new WindowBehavior(selector, this) { // NOSONAR

			private static final long serialVersionUID = 1L;

			@Override
			protected boolean isCentered()
			{
				return AbstractWindow.this.isCentered();
			}
		};
	}
}