ilog.views.dashboard

Class IlvDashboardContext

java.lang.Object

ilog.views.dashboard.IlvDashboardContext

Direct Known Subclasses:

IlvDashboardEditor

public class IlvDashboardContext
extends Object

IlvDashboardContext provides the global context used by a dashboard diagram and its related objects. You need a IlvDashboardContext object to create an IlvDashboardDiagram instance.

Introducing Dashboard Context

An IlvDashboardContext instance contains the following context data:

• A ResourceBundle for stocking locale specific data.
• The parent component of any dialog windows used by your dashboard application.
• The URL to the style sheet file (.css) used to render the dashboard diagram.
• An IlvPaletteManager used to load and unload palettes in your application.
• Whether default mapping is used to connect symbols imported into a dashboard diagram with the SDM engine automatically.
• An internal logging object that uses a Java Logger object.

Each context element mentioned above can be changed during the life of this object.

Example

The following code sample shows how to use a IlvDashboardContext instance to create a IlvDashboardDiagram instance.

      IlvDashboardContext dashContext = new IlvDashboardContext();
      IlvDashboardDiagram dashDiag = new IlvDashboardDiagram(dashContext);        
 

Since:

JViews 8.0

See Also:

IlvDashboardDiagram, IlvDashboardEditor

Field Summary

Fields

Modifier and Type	Field and Description
static String	VERSION

Constructor Summary

Constructors

Constructor and Description
IlvDashboardContext() Constructs an IlvDashboardContext instance using the default resource bundle.
IlvDashboardContext(ResourceBundle bundle) Constructs an IlvDashboardContext instance adding the locale specific information resources in bundle.

Method Summary

Modifier and Type	Method and Description
Component	getDialogParent() Returns the Java Component that will be used as the parent for dialog windows in your dashboard application.
Logger	getLogger() Returns the Java Logger used by the ilog.views.dashboard package.
IlvPaletteManager	getPaletteManager() Returns the palette manager used by this dashboard context.
ResourceBundle	getResourceBundle() Returns the locale specific information contained in this object.
URL	getStyleSheetURL() Returns the URL holding the location of the CSS file used to render IlvDashboardDiagrams utilizing this IlvDashboardContext.
boolean	isDefaultMappingEnabled() Checks if symbol parameters are automatically mapped to SDM object properties when it is added to a dashboard diagram.
IlvPalette	loadPalette(String packageName) Loads a symbol palette in packageName using the local IlvPaletteManager.
IlvPalette[]	loadPalettes(URL paletteURL) This method loads the content of jar file containing one or more palette definitions.
void	logMessage(Level level, String message) Logs message at level to the Logger used by your dashboard application.
void	setDefaultMappingEnabled(boolean enabled) Sets whether symbol parameters are automatically mapped to SDM object properties when it is added to a dashboard diagram.
void	setDialogParent(Component component) Sets the Java parent Component used for any dialog window created by a dashboard component.
void	setStyleSheetURL(URL url) Sets the URL holding the location of the CSS file used to render IlvDashboardDiagrams utilizing this IlvDashboardContext.

Methods inherited from class java.lang.Object

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

Field Detail

VERSION

public static final String VERSION

See Also:

Constant Field Values

Internal: do not use!

Constructor Detail

IlvDashboardContext

public IlvDashboardContext()

Constructs an IlvDashboardContext instance using the default resource bundle.

See Also:

IlvDashboardContext(ResourceBundle), Example

IlvDashboardContext

public IlvDashboardContext(ResourceBundle bundle)

Constructs an IlvDashboardContext instance adding the locale specific information resources in bundle.

Note: if bundle is null, the default resource bundle is used to instantiate the IlvDashboardContext instance.

Parameters:

bundle - A resource bundle with locale specific information to be used by a dashboard diagram via this IlvDashboardContext instance.

See Also:

IlvDashboardContext()

Method Detail

getResourceBundle

public ResourceBundle getResourceBundle()

Returns the locale specific information contained in this object.

Returns:

The resource bundle used by this object.

getDialogParent

public Component getDialogParent()

Returns the Java Component that will be used as the parent for dialog windows in your dashboard application. When a dialog window is created by a dashboard component for any purpose, this Component is used as the parent window.

Note: this attribute is not instantiated when the IlvDashboardContext class is created. Call setDialogParent to set the parent component.

Returns:

A Component to be used as parent for dialog windows in your dashboard application.

See Also:

setDialogParent(Component)

setDialogParent

public void setDialogParent(Component component)

Sets the Java parent Component used for any dialog window created by a dashboard component.

Note: this attribute is not instantiated when the IlvDashboardContext class is created. You must call this method to set the parent component.

Parameters:

component - The parent Java Component for dialog windows attached to a dashboard application.

See Also:

getDialogParent()

getStyleSheetURL

public URL getStyleSheetURL()

Returns the URL holding the location of the CSS file used to render IlvDashboardDiagrams utilizing this IlvDashboardContext.

Change this style sheet by calling setStyleSheetURL.

Returns:

The URL to the current style sheet.

See Also:

setStyleSheetURL(URL)

setStyleSheetURL

public void setStyleSheetURL(URL url)

Sets the URL holding the location of the CSS file used to render IlvDashboardDiagrams utilizing this IlvDashboardContext.

Parameters:

url - The URL to the current style sheet.

See Also:

getStyleSheetURL()

getPaletteManager

public IlvPaletteManager getPaletteManager()

Returns the palette manager used by this dashboard context.

This IlvPaletteManager instance is used to load, save and manage palettes.

Returns:

The palette manager used by this dashboard context.

loadPalette

public IlvPalette loadPalette(String packageName)

Loads a symbol palette in packageName using the local IlvPaletteManager.

Parameters:

packageName - The name of the package containing the symbol palette the user wants to load.

Returns:

The loaded symbol palette.

See Also:

IlvPaletteManager, IlvPaletteManager.load(java.lang.String)

loadPalettes

public IlvPalette[] loadPalettes(URL paletteURL)

This method loads the content of jar file containing one or more palette definitions.

Parameters:

paletteURL - A fully qualified URL containing the path to the palette the user wants to load.

Returns:

An array containing the instances of the palettes that have been loaded.

See Also:

loadPalette(String), IlvPaletteManager, IlvPaletteManager.load(java.net.URL)

isDefaultMappingEnabled

public boolean isDefaultMappingEnabled()

Checks if symbol parameters are automatically mapped to SDM object properties when it is added to a dashboard diagram.

Returns:

true if default mapping is enabled.

See Also:

setDefaultMappingEnabled(boolean), Rendering symbols

setDefaultMappingEnabled

public void setDefaultMappingEnabled(boolean enabled)

Sets whether symbol parameters are automatically mapped to SDM object properties when it is added to a dashboard diagram.

Parameters:

enabled - Set to true to enable default SDM mapping.

See Also:

isDefaultMappingEnabled(), Rendering symbols

getLogger

public Logger getLogger()

Returns the Java Logger used by the ilog.views.dashboard package.

Returns:

the Logger instance used to trace a dashboard application.

See Also:

logMessage(Level, String)

logMessage

public void logMessage(Level level,
                       String message)

Logs message at level to the Logger used by your dashboard application.

Parameters:

level - The level at which to log message.

message - The message to log.

See Also:

getLogger()