org.wicketstuff.whiteboard.Whiteboard Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of wicketstuff-whiteboard Show documentation
There is a newer version: 8.0.0-M7
Show newest version
/*
 * 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.whiteboard;

import org.apache.wicket.markup.html.WebMarkupContainer;
import org.apache.wicket.markup.html.panel.Panel;
import org.apache.wicket.protocol.ws.api.WebSocketBehavior;
import org.apache.wicket.protocol.ws.api.message.ClosedMessage;
import org.apache.wicket.protocol.ws.api.message.ConnectedMessage;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * This is the whiteboard main class
 * 
 * @author andunslg
 */
public class Whiteboard extends Panel {
	private static final Logger log = LoggerFactory.getLogger(Whiteboard.class);
	private static final long serialVersionUID = 1L;

	/**
	 * This is the constructor which used to create a whiteboard in a wicket application
	 * 
	 * @param markupId
	 *            html element markupId which holds the whiteboard
	 * @param whiteboardContent
	 *            If loading from a saved whiteboard file, content should be provided as a string. Otherwise null
	 * @param clipArtFolderPath
	 *            Path of the folder which holds clipArts which can be added to whiteboard. Relative to context root
	 * @param docFolderPath
	 *            Path of the folder which holds docs images which can be added to whiteboard. Relative to context root
	 */
	public Whiteboard(String whiteboardID, String markupId, String whiteboardContent, String clipArtFolderPath,
			String docFolderPath) {
		super(markupId);

		// Adding Web Socket behaviour to handle synchronization between whiteboards

		this.add(new WebSocketBehavior() {
			private static final long serialVersionUID = -3311970325911992958L;

			@Override
			protected void onConnect(ConnectedMessage message) {
				super.onConnect(message);
				log.debug("Connecting :" + message.toString());
			}

			@Override
			protected void onClose(ClosedMessage message) {
				super.onClose(message);
				log.debug("Disconnecting :" + message.toString());
			}
		});

		add(new WebMarkupContainer("whiteboard"));
		add(new WhiteboardBehavior(whiteboardID, "whiteboard", whiteboardContent, clipArtFolderPath, docFolderPath));
	}
}