com.googlecode.wicket.jquery.ui.widget.dialog.MessageFormDialog Maven / Gradle / Ivy

Go to download
/*
 * 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 com.googlecode.wicket.jquery.ui.widget.dialog;

import java.util.List;

import org.apache.wicket.AttributeModifier;
import org.apache.wicket.ajax.AjaxRequestTarget;
import org.apache.wicket.markup.html.WebMarkupContainer;
import org.apache.wicket.markup.html.basic.Label;
import org.apache.wicket.markup.html.panel.EmptyPanel;
import org.apache.wicket.model.IModel;
import org.apache.wicket.model.Model;

/**
 * Provides a modal dialog box that display a specific message, with a predefined icon and a predefined button set.
 * Note:  {@link MessageDialog} & {@link MessageFormDialog} are sharing the same code. There just do not extends the same class.
 *
 * @author Sebastien Briquet - sebfz1
 */
public abstract class MessageFormDialog extends AbstractFormDialog
{
	private static final long serialVersionUID = 1L;

	private Label label;
	private DialogButtons buttons;

	/**
	 * Constructor.
	 * @param id the markupId, an html div suffice to host a dialog.
	 * @param title the title of the dialog
	 * @param message the message to be displayed
	 * @param buttons button set to display
	 */
	public MessageFormDialog(String id, String title, String message, DialogButtons buttons)
	{
		this(id, title, message, buttons, DialogIcon.NONE);
	}

	/**
	 * Constructor.
	 * @param id the markupId, an html div suffice to host a dialog.
	 * @param title the title of the dialog
	 * @param message the message to be displayed
	 * @param buttons button set to display
	 */
	public MessageFormDialog(String id, IModel title, IModel message, DialogButtons buttons)
	{
		this(id, title, message, buttons, DialogIcon.NONE);
	}

	/**
	 * Constructor.
	 * @param id the markupId, an html div suffice to host a dialog.
	 * @param title the title of the dialog
	 * @param message the message to be displayed
	 * @param buttons button set to display
	 * @param icon the predefined icon to display
	 */
	public MessageFormDialog(String id, String title, String message, DialogButtons buttons, DialogIcon icon)
	{
		this(id, Model.of(title), Model.of(message), buttons, icon);
	}

	/**
	 * Constructor.
	 * @param id the markupId, an html div suffice to host a dialog.
	 * @param title the title of the dialog
	 * @param message the message to be displayed
	 * @param buttons button set to display
	 * @param icon the predefined icon to display
	 */
	public MessageFormDialog(String id, IModel title, IModel message, DialogButtons buttons, DialogIcon icon)
	{
		super(id, title, message, true);
		this.buttons = buttons;

		WebMarkupContainer container = new WebMarkupContainer("container");
		this.add(container);

		container.add(AttributeModifier.append("class", icon.getStyle()));
		container.add(new EmptyPanel("icon").add(AttributeModifier.replace("class", icon)));

		this.label = new Label("message", this.getModel());
		container.add(this.label.setOutputMarkupId(true));
	}

	@Override
	protected final List getButtons()
	{
		if (this.buttons != null)
		{
			return this.buttons.toList();
		}

		return super.getButtons(); //cannot happen
	}

	@Override
	protected void onOpen(AjaxRequestTarget target)
	{
		target.add(this.label);
	}

	@Override
	public void onClose(AjaxRequestTarget target, DialogButton button)
	{
		//not mandatory to override
	}
}