com.pingunaut.wicket.chartjs.chart.IChart Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of wicket-chartjs Show documentation

chart.js for wicket projects. simple but nice looking charts with html5/css/js

There is a newer version: 7.0.1

/*******************************************************************************
 * Copyright 2013 Martin Spielmann
 * 
 * Licensed 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 com.pingunaut.wicket.chartjs.chart;

import java.io.Serializable;

import com.fasterxml.jackson.databind.ObjectMapper;
import com.pingunaut.wicket.chartjs.options.AbstractChartOptions;

/**
 * IChart provides chart options and a pojo-json mapper to communicate with
 * javascript.
 * 
 * @param 
 *            the generic type of options (has to extend
 *            {@link AbstractChartOptions})
 * 
 * @author Martin Spielmann
 */
public interface IChart extends Serializable {

	/**
	 * Gets the mapper.
	 * 
	 * @return an instance of {@link ObjectMapper} to be able to map pojos to
	 *         javascript objects and the other way round if necessary.
	 */
	public ObjectMapper getMapper();

	/**
	 * Sets the mapper.
	 * 
	 * @param mapper
	 *            the new mapper
	 */
	public void setMapper(final ObjectMapper mapper);

	/**
	 * Gets the options.
	 * 
	 * @return the charts options. these are the same options, which are
	 *         available for the pure javascript http://chart.js
	 * 
	 *         the implementations inside the impl package all override this
	 *         method to ensure {@code getOptions()} doesn't return {@code null}
	 *         , so you won't have to create a new one by yourself
	 */
	public O getOptions();
}