org.wicketstuff.kendo.ui.dataviz.chart.ChartPayload Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of wicketstuff-kendo-ui Show documentation
Wicket-Kendo UI
The 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.kendo.ui.dataviz.chart;

import org.apache.wicket.ajax.AjaxRequestTarget;
import org.apache.wicket.core.request.handler.IPartialPageRequestHandler;
import org.apache.wicket.util.io.IClusterable;
import org.wicketstuff.jquery.core.ajax.HandlerPayload;

/**
 * Provides a convenient {@link HandlerPayload} that can be used to broadcast a point information
 * 
 * @see Chart#onSeriesClick(AjaxRequestTarget, String, String, String, long)
 * @author Sebastien Briquet - sebfz1
 *
 */
public class ChartPayload extends HandlerPayload implements IClusterable // NOSONAR
{
	private static final long serialVersionUID = 1L;

	private final long value;
	private final String category;
	private final String seriesName;
	private final String seriesField;

	/**
	 * Constructor
	 * 
	 * @param handler the {@link IPartialPageRequestHandler}
	 * @param seriesName the series name
	 * @param seriesField the series field
	 * @param category the category
	 * @param value the value of the point
	 */
	public ChartPayload(IPartialPageRequestHandler handler, String seriesName, String seriesField, String category, long value)
	{
		super(handler);

		this.value = value;
		this.category = category;
		this.seriesName = seriesName;
		this.seriesField = seriesField;
	}

	/**
	 * Gets the value
	 * 
	 * @return the value
	 */
	public long getValue()
	{
		return this.value;
	}

	/**
	 * Get the category
	 * 
	 * @return the category
	 */
	public String getCategory()
	{
		return this.category;
	}

	/**
	 * Gets the series name
	 * 
	 * @return the series name
	 */
	public String getSeriesName()
	{
		return this.seriesName;
	}

	/**
	 * Gets the series field
	 * 
	 * @return the series field
	 */
	public String getSeriesField()
	{
		return this.seriesField;
	}
}