org.zkoss.zk.device.GenericDevice Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of zk Show documentation
ZK Kernel
There is a newer version: 10.0.0-jakarta
/* GenericDevice.java

	Purpose:
		
	Description:
		
	History:
		Thu Aug 23 18:44:47     2007, Created by tomyeh

Copyright (C) 2007 Potix Corporation. All Rights Reserved.

{{IS_RIGHT
	This program is distributed under LGPL Version 2.1 in the hope that
	it will be useful, but WITHOUT ANY WARRANTY.
}}IS_RIGHT
*/
package org.zkoss.zk.device;

import org.zkoss.zk.ui.Desktop;
import org.zkoss.zk.ui.sys.ServerPush;

/**
 * A skeletal implementation of {@link Device}.
 *
 * @author tomyeh
 * @since 3.0.0
 */
public abstract class GenericDevice implements Device {
	private String _type, _uamsg;
	private Class _spushcls;
	private String _embed;

	//Device//
	public boolean isSupported(int func) {
		return false;
	}

	public String getType() {
		return _type;
	}

	/** Return true to indicate it is cacheable.
	 */
	public boolean isCacheable() {
		return true;
	}

	/** Returns null to indicate unknown.
	 * Deriving should override it to provide more precise information.
	 */
	public Boolean isCompatible(String userAgent) {
		return null;
	}

	public String getUnavailableMessage() {
		return _uamsg;
	}

	public String setUnavailableMessage(String msg) {
		final String old = _uamsg;
		_uamsg = msg != null && msg.length() > 0 ? msg : null;
		return old;
	}

	public Class setServerPushClass(Class cls) {
		if (cls != null && !ServerPush.class.isAssignableFrom(cls))
			throw new IllegalArgumentException("ServerPush not implemented: " + cls);
		final Class old = _spushcls;
		_spushcls = cls;
		return old;
	}

	public Class getServerPushClass() {
		return _spushcls;
	}

	/** Returns null to indicate not to generate <!DOCTYPE> at all.
	 */
	public String getDocType() {
		return null;
	}

	public void addEmbedded(String content) {
		if (content != null && content.length() > 0)
			_embed = _embed != null ? _embed + '\n' + content : content;
	}

	public String getEmbedded() {
		return _embed;
	}

	/** Returns the name and version of the client if the given user agent
	 * matches this client, or null if not matched or it is a standard
	 * browser request.
	 * This implementation always returns null. That is, it assumes
	 * the client is a standard browser.
	 * @param userAgent represents a client (i.e., HTTP's user-agent).
	 * @return a pair of objects or null.
	 * The first element of the pair is the name of the client (String),
	 * the second element is the version (Double, such as 3.5).
	 * @since 6.0.0
	 */
	public Object[] matches(String userAgent) {
		return null;
	}

	/** Reloads the client-side messages in the specified locale.
	 * 
Default: throw UnsupportedOperationException.
	 * @since 5.0.4
	 */
	public void reloadMessages(java.util.Locale locale) throws java.io.IOException {
		throw new UnsupportedOperationException();
	}

	/** Converts a package to an absolute path that can be accessible by
	 * the class loader (classpath).
	 * 
Default: throw UnsupportedOperationException.
	 * @since 5.0.4
	 */
	public String packageToPath(String pkg) {
		throw new UnsupportedOperationException();
	}

	/** Converts a relative path to an absolute path that can be accessible by
	 * the class loader (classpath).
	 * Default: throw UnsupportedOperationException.
	 * @since 5.0.4
	 */
	public String toAbsolutePath(String path) {
		throw new UnsupportedOperationException();
	}

	public void init(String type, DeviceConfig config) {
		_type = type;
		_uamsg = config.getUnavailableMessage();
		_spushcls = config.getServerPushClass();
		_embed = config.getEmbedded();
	}

	public void sessionWillPassivate(Desktop desktop) {
	}

	public void sessionDidActivate(Desktop desktop) {
	}
}