com.levigo.jadice.document.render
Class DefaultRenderControls

java.lang.Object
  com.levigo.jadice.document.AbstractProcessingControls<RenderSettings>
      com.levigo.jadice.document.render.DefaultRenderControls

All Implemented Interfaces:

ProcessingControls<RenderSettings>, RenderControls

public class DefaultRenderControls
extends AbstractProcessingControls<RenderSettings>
implements RenderControls

An realization of RenderControls to be used as base class providing easy and fast access to the most commonly used ProcessingSettings. The RenderControls define a set of parameters that control the process of rendering content.

Field Summary

Fields inherited from class com.levigo.jadice.document.AbstractProcessingControls

settings

Constructor Summary

DefaultRenderControls()

DefaultRenderControls(DefaultRenderControls rc)
Construct a new AbstractRenderControls and initialize it with the same settings as the given one.

Method Summary

void	addRenderSettingsListener(RenderSettingsListener listener) Adds a RenderSettingsListener for receiving render settings change events.
void	clearSettings(Class<? extends RenderSettings> c) Clear the settings of the given class.
DefaultRenderControls	createSnapshot() Creates a snapshot copy of this render control object.
BaseRenderSettings	getBaseRenderSettings() Return the BaseRenderSettings.
ImageRenderSettings	getImageRenderSettings() Return the ImageRenderSettings.
static RenderControls	getNotNull(RenderControls controls) Utility method.
List<RenderSettingsListener>	getRenderSettingsListeners() Returns a list of currently registered listeners.
Collection<RenderSettings>	getSettings()
<S extends RenderSettings> S	getSettings(Class<S> c) Return a particular instance of ProcessingSettings selected by its class.
TextRenderSettings	getTextRenderSettings() Return the TextRenderSettings.
void	removeRenderSettingsListener(RenderSettingsListener listener) Removes a RenderSettingsListener.

Methods inherited from class com.levigo.jadice.document.AbstractProcessingControls

equals, hashCode, isModified

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultRenderControls

public DefaultRenderControls()

DefaultRenderControls

public DefaultRenderControls(DefaultRenderControls rc)

Construct a new AbstractRenderControls and initialize it with the same settings as the given one.

Parameters:

rc - AbstractRenderControls from which to copy the settings.

Method Detail

getNotNull

public static RenderControls getNotNull(RenderControls controls)

Utility method. Can be called to ensure a not null controls object. If the given controls object is not null, it will be returned. Otherwise a DefaultRenderControls instance with screen resolution will be created and returned.

Parameters:

controls - the controls object to checked

Returns:

the given controls object if not null. Otherwise a DefaultRenderControls object with screen resolution will be returned.

clearSettings

public void clearSettings(Class<? extends RenderSettings> c)

Description copied from interface: ProcessingControls

Clear the settings of the given class.

Specified by:

clearSettings in interface ProcessingControls<RenderSettings>

Overrides:

clearSettings in class AbstractProcessingControls<RenderSettings>

Parameters:

c - the class of settings to clear.

See Also:

ProcessingControls.clearSettings(java.lang.Class)

getBaseRenderSettings

public BaseRenderSettings getBaseRenderSettings()

Description copied from interface: RenderControls

Return the BaseRenderSettings.

Specified by:

getBaseRenderSettings in interface RenderControls

See Also:

RenderControls.getBaseRenderSettings()

getImageRenderSettings

public ImageRenderSettings getImageRenderSettings()

Description copied from interface: RenderControls

Return the ImageRenderSettings.

Specified by:

getImageRenderSettings in interface RenderControls

See Also:

RenderControls.getImageRenderSettings()

getTextRenderSettings

public TextRenderSettings getTextRenderSettings()

Description copied from interface: RenderControls

Return the TextRenderSettings.

Specified by:

getTextRenderSettings in interface RenderControls

See Also:

RenderControls.getTextRenderSettings()

getSettings

public <S extends RenderSettings> S getSettings(Class<S> c)

Description copied from interface: ProcessingControls

Return a particular instance of ProcessingSettings selected by its class.

Specified by:

getSettings in interface ProcessingControls<RenderSettings>

Overrides:

getSettings in class AbstractProcessingControls<RenderSettings>

Parameters:

c - the class of settings to get.

Returns:

an instance of ProcessingSettings of the given class.

See Also:

AbstractProcessingControls.getSettings(java.lang.Class)

addRenderSettingsListener

public void addRenderSettingsListener(RenderSettingsListener listener)

Adds a RenderSettingsListener for receiving render settings change events.

Parameters:

listener - the listener to register

removeRenderSettingsListener

public void removeRenderSettingsListener(RenderSettingsListener listener)

Removes a RenderSettingsListener.

Parameters:

listener - the listener to remove

getRenderSettingsListeners

public List<RenderSettingsListener> getRenderSettingsListeners()

Returns a list of currently registered listeners. The list is a snapshot copy of the internal listener collection. As a consequence changes of the returned list will not force any changes of the registered listeners at this render control instance.

Returns:

a snapshot copy of the currently registered listeners.

createSnapshot

public DefaultRenderControls createSnapshot()

Description copied from interface: RenderControls

Creates a snapshot copy of this render control object. The snapshot must constitute a deep copy, so that changes to the copied object don't affect snapshots.

Specified by:

createSnapshot in interface ProcessingControls<RenderSettings>

Specified by:

createSnapshot in interface RenderControls

Returns:

a snapshot copy of this render control instance

See Also:

RenderControls.createSnapshot()

getSettings

public Collection<RenderSettings> getSettings()

Specified by:

getSettings in interface RenderControls