org.apache.wicket.settings.IPageSettings Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.ops4j.pax.wicket.service Show documentation
Pax Wicket Service is an OSGi extension of the Wicket framework, allowing for dynamic loading and unloading of Wicket components and pageSources.
There is a newer version: 5.0.0
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.apache.wicket.settings;

import java.util.List;

import org.apache.wicket.Application;
import org.apache.wicket.markup.html.WebPage;
import org.apache.wicket.markup.resolver.AutoComponentResolver;
import org.apache.wicket.markup.resolver.IComponentResolver;
import org.apache.wicket.protocol.http.SecondLevelCacheSessionStore;


/**
 * Interface for page related settings.
 * 
 * @author Igor Vaynberg (ivaynberg)
 * @author Eelco Hillenius
 */
public interface IPageSettings
{
	/**
	 * Adds a component resolver to the list.
	 * 
	 * @param resolver
	 *            The {@link IComponentResolver} that is added
	 */
	void addComponentResolver(IComponentResolver resolver);

	/**
	 * Get the (modifiable) list of IComponentResolvers.
	 * 
	 * @see AutoComponentResolver for an example
	 * @return List of ComponentResolvers
	 */
	List getComponentResolvers();

	/**
	 * Gets whether Wicket should try to support opening multiple windows for the same session
	 * transparently. If this is true - the default setting -, Wicket tries to detect whether a new
	 * window was opened by a user (e.g. in Internet Explorer by pressing ctrl+n or ctrl+click on a
	 * link), and if it detects that, it creates a new page map for that window on the fly. As a
	 * page map represents the 'history' of one window, each window will then have their own
	 * history. If two windows would share the same page map, the non-bookmarkable links on one
	 * window could refer to stale state after working a while in the other window.
	 * 
	 *  Currently, Wicket trying to do this is a best effort that is not completely fail
	 * safe. When the client does not support cookies, support gets tricky and incomplete. See
	 * {@link WebPage}'s internals for the implementation. 
	 * 
	 * 
	 * @return Whether Wicket should try to support multiple windows transparently
	 */
	boolean getAutomaticMultiWindowSupport();

	/**
	 * @return Returns the pagesVersionedByDefault.
	 */
	boolean getVersionPagesByDefault();

	/**
	 * @param pagesVersionedByDefault
	 *            The pagesVersionedByDefault to set.
	 */
	void setVersionPagesByDefault(boolean pagesVersionedByDefault);

	/**
	 * Sets whether Wicket should try to support opening multiple windows for the same session
	 * transparently. If this is true - the default setting -, Wicket tries to detect whether a new
	 * window was opened by a user (e.g. in Internet Explorer by pressing ctrl+n or ctrl+click on a
	 * link), and if it detects that, it creates a new page map for that window on the fly. As a
	 * page map represents the 'history' of one window, each window will then have their own
	 * history. If two windows would share the same page map, the non-bookmarkable links on one
	 * window could refer to stale state after working a while in the other window.
	 * 
	 *  Currently, Wicket trying to do this is a best effort that is not completely fail
	 * safe. When the client does not support cookies, support gets tricky and incomplete. See
	 * {@link WebPage}'s internals for the implementation. 
	 * 
	 * 
	 * NOTE:
	 * 
	 * When Wicket is used with {@link SecondLevelCacheSessionStore}, this store may disable this
	 * feature. See the javadoc of the second level store for details. This feature can be reenabled
	 * by calling this method from {@link Application#init}
	 * 
	 * @param automaticMultiWindowSupport
	 *            Whether Wicket should try to support multiple windows transparently
	 */
	void setAutomaticMultiWindowSupport(boolean automaticMultiWindowSupport);
}