com.softwarefx.chartfx.server
Class PersonalizeAttributes

java.lang.Object
  com.softwarefx.chartfx.server.PersonalizeAttributes

public class PersonalizeAttributes
extends Object

Provides access to the PersonalizeAttributes object, which allows access to the personalization features of ChartFX.

Many users require and demand information on an individual basis. Using personalized Chartallows users to change visual attributes and have those settings saved locally. When the user accesses the chart in the future, the saved settings can be automatically loaded setAutoLoad(boolean)so the users can view a chart configured to their personal preferences.

When using the personalized features for Chart FX, the users attribute changes must be saved locally on their computer. The setName(java.lang.String) property allows you to create unique or uniform names for your charts so the personalized settings can be loaded or saved.

Constructor Summary

PersonalizeAttributes()

Method Summary

void	dispose() Releases the unmanaged resources used by the object.
String	getName() Gets the Name.
boolean	isAutoLoad() Gets the AutoLoad.
boolean	isAutoSave() Gets the AutoSave.
boolean	isCanRestore() Returns True if the original chart can be restored.
boolean	isEnabled() Gets the Enabled.
boolean	isEnableRestore() Gets the EnableRestore.
boolean	load() Apply any previously saved personalizations to the chart.
void	restoreDefault() Clears all the transformations made by the end-user and resets the chart to the default personalization settings.
boolean	save() Saves the personalization settings configured for the chart.
void	setAsDefault() Sets the current personalization to the default personalization.
void	setAutoLoad(boolean value) Allows you to enable or disable the automatic loading of the chart personalization.
void	setAutoSave(boolean value) Sets a value indicating to enable or disable the automatic saving of the chart attributes.
void	setEnabled(boolean value) Allow you to enable the Personalize Attributes.
void	setEnableRestore(boolean value) Allow you to enable the restoration of the chart.
void	setName(String value) Allows you to set the personalization name of the chart.

Methods inherited from class java.lang.Object

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

Constructor Detail

PersonalizeAttributes

public PersonalizeAttributes()

Method Detail

dispose

public void dispose()

Releases the unmanaged resources used by the object. If the object is disposed, the attributes will no longer be stored in memory.

Remarks:

This method is used to perform application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. Please see your Java API documentation regarding use of the Dispose method.

getName

public String getName()

Gets the Name. For more detail see setName(java.lang.String).

isAutoLoad

public boolean isAutoLoad()

Gets the AutoLoad. For more detail see setAutoLoad(boolean).

isAutoSave

public boolean isAutoSave()

Gets the AutoSave. For more detail see setAutoSave(boolean).

isCanRestore

public boolean isCanRestore()

Returns True if the original chart can be restored. By default, thid property returns False but it will return True as soon as the end-user modifies any attribute of the chart or a saved chart is loaded.

Remarks:

The setEnableRestore(boolean) property allows you to enable restoration of the chart. When the user makes the first visual change to the chart through the UI, the original chart is saved in memory if EnableRestore is set to True.

The restoreDefault() property clears all the transformations made by the end-user and resets the chart to the default personalization settings

The Chart.getPersonalize() property returns the PersonalizeAttributes object of a chart, which the CanRestore member is available.

See Also:

setEnableRestore(boolean), isCanRestore(), Chart.getPersonalize(), restoreDefault(), Chart

isEnableRestore

public boolean isEnableRestore()

Gets the EnableRestore. For more detail see setEnableRestore(boolean).

isEnabled

public boolean isEnabled()

Gets the Enabled. For more detail see setEnabled(boolean).

load

public boolean load()

Apply any previously saved personalizations to the chart.

Remarks:

The load() method returns False if there are no personalization settings saved.

The personalization can be saved using the Chart.exportChart(java.io.OutputStream) method of the Chart Class . Chart.setFileContents(java.util.EnumSet) should be set to Template or BinaryTemplate to save only the personalization.

See Also:

setAutoLoad(boolean), Chart.setFileContents(java.util.EnumSet), save(), Chart.exportChart(java.io.OutputStream)

restoreDefault

public void restoreDefault()

Clears all the transformations made by the end-user and resets the chart to the default personalization settings.

Remarks:

The Chart.getPersonalize() property returns the PersonalizeAttributes object of a chart, when the RestoreDefaults member is available.

The isCanRestore() property returns True if the original chart can be restored. By default, this property returns False but it will return True as soon as the end-user modifies any attribute of the chart or a saved chart is loaded.

The setEnableRestore(boolean) property allows you to enable restoration of the chart. When the user makes the first visual change to the chart through the UI, the original chart is saved in memory if EnableRestore is set to True.

See Also:

isCanRestore(), setEnableRestore(boolean), Chart.getPersonalize(), setAsDefault(), Chart

save

public boolean save()

Saves the personalization settings configured for the chart.

Remarks:

The personalization can be saved using the Chart.importChart(java.io.InputStream)Chart.exportChart(java.io.OutputStream)method of the Chart Class . Chart.setFileContents(java.util.EnumSet)should be set to Template or BinaryTemplate to only save the personalization.

See Also:

setAutoSave(boolean), load(), Chart.importChart(java.io.InputStream)

setAsDefault

public void setAsDefault()

Sets the current personalization to the default personalization.

Remarks:

The supported members of the PersonalizeAttributes object allow you to customize the personalization features for the chart. setAutoLoad(boolean), setAutoSave(boolean), isCanRestore(), setEnableRestore(boolean) are all supported attributes. Using the setAsDefault() property, developers can configure the current settings as the default settings for that chart.

The Chart.getPersonalize() property returns the PersonalizeAttributes object of a chart.

See Also:

Chart.getPersonalize(), setAutoLoad(boolean), setAutoSave(boolean), isCanRestore(), setEnableRestore(boolean), restoreDefault(), Chart

setAutoLoad

public void setAutoLoad(boolean value)

Allows you to enable or disable the automatic loading of the chart personalization. When AutoLoad is set to True, the personalized features are automatically loaded when the chart is created.

Remarks:

When AutoLoad is set to True, Chart FX will look for a saved transformation file in the user's local Isolated Storage before the chart is rendered. If found, the settings will be applied to the chart. This functions as if the user selected the "Load My Chart" option in the Personalization toolbar options. By default this option is disabled.

The setAutoSave(boolean) property gets or sets a value indicating to enable or disable the automatic saving of the chart attributes. When setAutoSave(boolean) is set to True, the personalized features are automatically saved when the chart is destroyed.

The setEnableRestore(boolean) property allows you to enable restoration of the chart. When the user makes the first visual change to the chart through the UI, the original chart is saved in memory if EnableRestore is set to True.

The isCanRestore() property returns True if the original chart can be restored. By default, returns False but it will return True as soon as the end-user modifies any attribute of the chart or a saved chart is loaded.

The Chart.getPersonalize() property returns the PersonalizeAttributes object of a chart.

See Also:

setAutoSave(boolean), setEnableRestore(boolean), isCanRestore(), Chart.getPersonalize(), load(), Chart

setAutoSave

public void setAutoSave(boolean value)

Sets a value indicating to enable or disable the automatic saving of the chart attributes. When AutoSave is set to True, the personalized features are automatically saved when the chart is destroyed.

Remarks:

Any transformations made to the chart will be automatically saved to the Isolated Storage when the chart is destroyed (the browser is refreshed or closed, or another page is invoked). By default this option is disabled.

The setAutoLoad(boolean) property gets or sets a value indicating to enable or disable the automatic loading of the chart personalization. When setAutoLoad(boolean) is set to True, the personalized features are automatically loaded when the chart is created.

The setEnableRestore(boolean) property allows you to enable restoration of the chart. When the user makes the first visual change to the chart through the UI, the original chart is saved in memory if EnableRestore is set to True.

The isCanRestore() property returns True if the original chart can be restored. By default, returns False but it will return True as soon as the end-user modifies any attribute of the chart or a saved chart is loaded.

The Chart.getPersonalize() property returns the PersonalizeAttributes object of a chart.

See Also:

setAutoLoad(boolean), setEnableRestore(boolean), isCanRestore(), Chart.getPersonalize(), save(), Chart

setEnableRestore

public void setEnableRestore(boolean value)

Allow you to enable the restoration of the chart. When the user makes the first visual change to the chart through the UI, the original chart is saved in memory when this property is set to True.

Remarks:

The isCanRestore() property returns True if the original chart can be restored. By default, this property returns False but it will return True as soon as the end-user modifies any attribute of the chart or a saved chart is loaded.

The restoreDefault() property clears all the transformations made by the end-user and resets the chart to the default personalization settings.

The Chart.getPersonalize() property returns the PersonalizeAttributes object of a chart, which the CanRestore member is available.

See Also:

isCanRestore(), Chart.getPersonalize(), restoreDefault(), Chart

setEnabled

public void setEnabled(boolean value)

Allow you to enable the Personalize Attributes.

Remarks:

The setAutoLoad(boolean) property gets or sets a value indicating to enable or disable the automatic loading of the chart personalization. When setAutoLoad(boolean) is set to True, the personalized features are automatically loaded when the chart is created.

The setAutoSave(boolean) property gets or sets a value indicating to enable or disable the automatic saving of the chart attributes. When setAutoSave(boolean) is set to True, the personalized features are automatically saved when the chart is destroyed.

The isCanRestore() property returns True if the original chart can be restored. By default, returns False but it will return True as soon as the end-user modifies any attribute of the chart or a saved chart is loaded.

The setEnableRestore(boolean) property allows you to enable restoration of the chart. When the user makes the first visual change to the chart through the UI, the original chart is saved in memory if EnableRestore is set to True.Chart.getPersonalize()

The Chart.getPersonalize() property returns the PersonalizeAttributes object of a chart.

setName

public void setName(String value)

Allows you to set the personalization name of the chart.

Remarks:

When using the personalized features for Chart FX, the users attribute changes must be saved locally on their computer. The Name property allows you to create unique or uniform names for your charts so the personalized settings can be load()or save().

See Also:

load(), save()