org.apache.shindig.gadgets

Class Gadget

java.lang.Object

org.apache.shindig.gadgets.Gadget

public class Gadget
extends Object

Intermediary representation of all state associated with processing of a single gadget request.

Constructor Summary

Constructors

Constructor and Description
Gadget()

Method Summary

Methods

Modifier and Type	Method and Description
void	addFeature(String name)
List<String>	getAllFeatures()
GadgetContext	getContext()
View	getCurrentView()
Set<String>	getDirectFeatureDeps()
LocaleSpec	getLocale() Convenience function for getting the locale spec for the current context.
Collection<PreloadedData>	getPreloads()
GadgetSpec	getSpec()
OpenSocialVersion	getSpecificationVersion() Returns open social specification version for this Gadget
Map<String,Feature>	getViewFeatures() Convenience method that returns Map of features to load for gadget's current view
void	removeFeature(String name)
boolean	requiresCaja() True if the gadget opts into caja or the container forces caja
boolean	sanitizeOutput() Should the gadget content be sanitized on output
Gadget	setContext(GadgetContext context)
Gadget	setCurrentView(View currentView)
Gadget	setGadgetFeatureRegistry(FeatureRegistry registry)
Gadget	setPreloads(Collection<PreloadedData> preloads)
Gadget	setSpec(GadgetSpec spec)
boolean	useQuirksMode() Returns if the doctype attribute is set to quirksmode.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Gadget

public Gadget()

Method Detail

setContext

public Gadget setContext(GadgetContext context)

Parameters:

context - The request that the gadget is being processed for.

getContext

public GadgetContext getContext()

setGadgetFeatureRegistry

public Gadget setGadgetFeatureRegistry(FeatureRegistry registry)

Parameters:

registry - The gadget feature registry to use to find dependent features.

setSpec

public Gadget setSpec(GadgetSpec spec)

Parameters:

spec - The spec for the gadget that is being processed.

getSpec

public GadgetSpec getSpec()

getSpecificationVersion

public OpenSocialVersion getSpecificationVersion()

Returns open social specification version for this Gadget

Returns:

Version for this Gadget

useQuirksMode

public boolean useQuirksMode()

Returns if the doctype attribute is set to quirksmode. Needed to override default OpenSocial 2.0 behavior which is to render in standards mode, may not be possible to honor this attribute when inlining (caja)

Returns:

TRUE if this Gadget should be rendered in browser quirks mode

setPreloads

public Gadget setPreloads(Collection<PreloadedData> preloads)

Parameters:

preloads - The preloads for the gadget that is being processed.

getPreloads

public Collection<PreloadedData> getPreloads()

getAllFeatures

public List<String> getAllFeatures()

setCurrentView

public Gadget setCurrentView(View currentView)

getCurrentView

public View getCurrentView()

Returns:

The View applicable for the current request.

getLocale

public LocaleSpec getLocale()

Convenience function for getting the locale spec for the current context. Identical to: Locale locale = gadget.getContext().getLocale(); gadget.getSpec().getModulePrefs().getLocale(locale);

addFeature

public void addFeature(String name)

removeFeature

public void removeFeature(String name)

getDirectFeatureDeps

public Set<String> getDirectFeatureDeps()

getViewFeatures

public Map<String,Feature> getViewFeatures()

Convenience method that returns Map of features to load for gadget's current view

Returns:

a map of ModuleSpec/Require and ModuleSpec/Optional elements to Feature

sanitizeOutput

public boolean sanitizeOutput()

Should the gadget content be sanitized on output

Returns:

requiresCaja

public boolean requiresCaja()

True if the gadget opts into caja or the container forces caja