/*
* 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.ajax.attributes;
import org.apache.wicket.markup.html.WebComponent;
import org.apache.wicket.util.io.IClusterable;
import org.apache.wicket.util.lang.Args;
import org.apache.wicket.util.time.Duration;
/**
* Class to keep track of throttling settings.
*
* @author ivaynberg
*/
public class ThrottlingSettings implements IClusterable
{
private static final long serialVersionUID = 1L;
private Duration delay;
private final String id;
private boolean postponeTimerOnUpdate;
/**
* Construct without id (will default to the component's markup ID) and postponeTimerOnUpdate
* set to false.
*
* @param delay
* throttle delay
*/
public ThrottlingSettings(final Duration delay)
{
this(null, delay, false);
}
/**
* Construct without id (will default to the component's markup ID).
*
* @param delay
* throttle delay
* @param postponeTimerOnUpdate
* postpone timer
*/
public ThrottlingSettings(final Duration delay, boolean postponeTimerOnUpdate)
{
this(null, delay, postponeTimerOnUpdate);
}
/**
* Construct.
*
* @param id
* throttle id
* @param delay
* throttle delay
*/
public ThrottlingSettings(final String id, final Duration delay)
{
this(id, delay, false);
}
/**
* Construct.
*
* @param id
* throttle id
* @param delay
* the amount of time the action should be postponed
*/
public ThrottlingSettings(final String id, final Duration delay,
final boolean postponeTimerOnUpdate)
{
this.id = id;
this.delay = Args.notNull(delay, "delay");
this.postponeTimerOnUpdate = postponeTimerOnUpdate;
}
/**
* @return the amount of time the action should be postponed
*/
public Duration getDelay()
{
return delay;
}
public void setDelay(Duration delay)
{
this.delay = Args.notNull(delay, "delay");
}
/**
* This id is used by the client-side throttling code to keep track of the various event
* throttles. Normally you can just use any unique ID here, such as the component's markupId (
* {@link WebComponent#getMarkupId()}). To unite several different events with one throttle,
* give them the same ID. If this is null, it will (on the client only) default to the
* component's markupId.
*
* @return throttle id
*/
public String getId()
{
return id;
}
/**
* If it is set to true, then the timer is reset each time the throttle function gets called.
* Use this behaviour if you want something to happen at X milliseconds after the
* <strong>last</strong> call to throttle. If the parameter is not set, or set to false, then
* the timer is not reset.
*/
public boolean getPostponeTimerOnUpdate()
{
return postponeTimerOnUpdate;
}
public void setPostponeTimerOnUpdate(boolean postponeTimerOnUpdate)
{
this.postponeTimerOnUpdate = postponeTimerOnUpdate;
}
}