GuiDemoCalloutWindowController.java

/**
 * <a href="http://www.openolat.org">
 * OpenOLAT - Online Learning and Training</a><br>
 * <p>
 * Licensed under the Apache License, Version 2.0 (the "License"); <br>
 * you may not use this file except in compliance with the License.<br>
 * You may obtain a copy of the License at the
 * <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache homepage</a>
 * <p>
 * Unless required by applicable law or agreed to in writing,<br>
 * software distributed under the License is distributed on an "AS IS" BASIS, <br>
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. <br>
 * See the License for the specific language governing permissions and <br>
 * limitations under the License.
 * <p>
 * Initial code contributed and copyrighted by<br>
 * frentix GmbH, http://www.frentix.com
 * <p>
 */
package org.olat.gui.demo.guidemo;

import org.olat.admin.user.UserSearchController;
import org.olat.core.gui.UserRequest;
import org.olat.core.gui.components.Component;
import org.olat.core.gui.components.link.Link;
import org.olat.core.gui.components.link.LinkFactory;
import org.olat.core.gui.components.panel.Panel;
import org.olat.core.gui.components.text.TextComponent;
import org.olat.core.gui.components.text.TextFactory;
import org.olat.core.gui.components.velocity.VelocityContainer;
import org.olat.core.gui.control.Controller;
import org.olat.core.gui.control.Event;
import org.olat.core.gui.control.WindowControl;
import org.olat.core.gui.control.controller.BasicController;
import org.olat.core.gui.control.generic.closablewrapper.CloseableCalloutWindowController;
import org.olat.core.gui.control.generic.closablewrapper.CloseableModalController;
import org.olat.core.gui.dev.controller.SourceViewController;

/**
 * Description:<br>
 * Demo of the callout window usage
 * 
 * <P>
 * Initial Date: 25.10.2010 <br>
 * 
 * @author gnaegi
 */
public class GuiDemoCalloutWindowController extends BasicController {
	private VelocityContainer contentVC;
	private Link calloutTriggerLink, calloutTriggerLink2;
	private CloseableCalloutWindowController calloutCtr, calloutCtr2, calloutCtr3;

	public GuiDemoCalloutWindowController(UserRequest ureq, WindowControl wControl) {
		super(ureq, wControl);
		contentVC = createVelocityContainer("calloutWindow");

		// Add callout trigger links
		calloutTriggerLink = LinkFactory.createButton("calloutTriggerLink", contentVC, this);
		calloutTriggerLink2 = LinkFactory.createButton("calloutTriggerLink2", contentVC, this);
		// The third callout trigger is implemented via javascript, see
		// calloutWindow.html file

		// Add source view control
		Controller sourceview = new SourceViewController(ureq, wControl, this.getClass(), contentVC);
		contentVC.put("sourceview", sourceview.getInitialComponent());
		
		CloseableModalController cmc = new CloseableModalController(wControl, "close", contentVC);
		putInitialPanel(new Panel("sf"));

		cmc.activate();
	}

	/**
	 * @see org.olat.core.gui.control.DefaultController#doDispose(boolean)
	 */
	@Override
	protected void doDispose() {
		// child controllers are auto disposed by basic controller
	}

	/**
	 * @see org.olat.core.gui.control.DefaultController#event(org.olat.core.gui.UserRequest,
	 *      org.olat.core.gui.components.Component,
	 *      org.olat.core.gui.control.Event)
	 */
	@Override
	public void event(UserRequest ureq, Component source, Event event) {
		if (source == calloutTriggerLink) {
			if (calloutCtr == null) {
				// Open callout window and provide a DOM trigger ID manually from a
				// link. The content is a little two step workflow (user search)
				UserSearchController ctr = new UserSearchController(ureq, getWindowControl(), false);
				calloutCtr = new CloseableCalloutWindowController(ureq, getWindowControl(), ctr.getInitialComponent(), "o_c"
						+ calloutTriggerLink.getDispatchID(), null, true, null);
				calloutCtr.addDisposableChildController(ctr);
				calloutCtr.activate();
				listenTo(calloutCtr);
			} else {
				// When window is already opened, second click on trigger should close
				// it again.
				removeAsListenerAndDispose(calloutCtr);
				calloutCtr = null;
			}
		} else if (source == calloutTriggerLink2) {
			if (calloutCtr2 == null) {
				// Open callout window and provide a DOM trigger link. The content is
				// some static text.
				TextComponent calloutPanel = TextFactory
						.createTextComponentFromString(
								"bla",
								"Just some random text here<br />Note that this window has no close button! <br /><br /><b>Click the button a second time to close this window.</b>",
								null, false, null);
				calloutCtr2 = new CloseableCalloutWindowController(ureq, getWindowControl(), calloutPanel, calloutTriggerLink2, "This is a title in a callout window", false, null);
				calloutCtr2.activate();
				listenTo(calloutCtr2);
			} else {
				// When window is already opened, second click on trigger should close
				// it again.
				removeAsListenerAndDispose(calloutCtr2);
				calloutCtr2 = null;
			}

		} else if (source == contentVC) {
			// A more complex example with a manualy crafted event to trigger the
			// callout window
			if ("trigger3".equals(event.getCommand())) {
				if (calloutCtr3 == null) {
					// open callout window
					TextComponent calloutPanel = TextFactory
							.createTextComponentFromString(
									"blu",
									"Cras dictum. Maecenas ut turpis. In vitae erat ac orci dignissim eleifend. Nunc quis justo. Sed vel ipsum in purus tincidunt pharetra. Sed pulvinar, felis id consectetuer malesuada, enim nisl mattis elit, a facilisis tortor nibh quis leo. Sed augue lacus, pretium vitae, molestie eget, rhoncus quis, elit. Donec in augue. Fusce orci wisi, ornare id, mollis vel, lacinia vel, massa. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas.",
									"o_error", false, null);
					calloutCtr3 = new CloseableCalloutWindowController(ureq, getWindowControl(), calloutPanel, "myspecialdomid", null, true, "trigger3");
					calloutCtr3.activate();
					listenTo(calloutCtr3);
				} else {
					// When window is already opened, second click on trigger should close
					// it again.
					removeAsListenerAndDispose(calloutCtr3);
					calloutCtr3 = null;
				}
			}
		}
	}

	/**
	 * 
	 * @see org.olat.core.gui.control.DefaultController#event(org.olat.core.gui.UserRequest,
	 *      org.olat.core.gui.control.Controller, org.olat.core.gui.control.Event)
	 */
	public void event(UserRequest ureq, Controller source, Event event) {
		// The CloseableCalloutWindowController fires the CLOSE_WINDOW_EVENT. When
		// you get this event you don't have to do anything, the window is already
		// deactivated. Alternatively you could also call the deactivate method
		// manually to close the window whenever you like.
		if (source == calloutCtr) {
			if (event == CloseableCalloutWindowController.CLOSE_WINDOW_EVENT) {
				removeAsListenerAndDispose(calloutCtr);
				calloutCtr = null;
			}
		} else if (source == calloutCtr2) {
			if (event == CloseableCalloutWindowController.CLOSE_WINDOW_EVENT) {
				removeAsListenerAndDispose(calloutCtr2);
				calloutCtr2 = null;
			}
		} else if (source == calloutCtr3) {
			if (event == CloseableCalloutWindowController.CLOSE_WINDOW_EVENT) {
				removeAsListenerAndDispose(calloutCtr3);
				calloutCtr3 = null;
			}
		}

	}

}