com.googlecode.wickedcharts.highcharts.options.processing

Interface IOptionsProcessor

public interface IOptionsProcessor

Interface for processing Options before they are renderer.

Author:

Tom Hombergs (tom.hombergs@gmail.com)

Method Summary

Methods

Modifier and Type	Method and Description
void	processOptions(Options options, OptionsProcessorContext context) Processes the given Options.

Method Detail

processOptions

void processOptions(Options options,
                  OptionsProcessorContext context)

Processes the given Options. This method gives the opportunity to modify an Options object before it is rendered as JSON.

Example usage of this interface:

1. When adding a certain configuration option to your Options object, that object calls Options.markForProcessing(com.googlecode.wickedcharts.highcharts.options.IProcessableOption) to mark itself for later processing by an IOptionsProcessor.
2. An IOptionsProcessor calls Options.getMarkedForProcessing(String) to get a list of all option objects marked this way.
3. The IOptionsProcessor modifies the Options object based on the information it gets from the marked objects.

This class is not part of the public API!

Parameters:

options - the Options to process or modify.

context - the context containing some context variables that may be accessed and changed by the processor.