ilog.cpl.graphic

Class IlpBasicGraphicViewStyleManager

java.lang.Object

ilog.cpl.graphic.IlpBasicGraphicViewStyleManager

All Implemented Interfaces:

IlpGraphicViewStyleManager, IlpStyleManager

Deprecated.

The Style API has been replaced by the Cascading Style Sheet mechanism. Refer to the User's Manual for further information.

@Deprecated
public class IlpBasicGraphicViewStyleManager
extends Object
implements IlpGraphicViewStyleManager

This class models the basic implementation of a graphic view configuration. It stores information about styles and renderers that are specific to a view and are used to create the graphic representation of the objects.

The basic graphic view style manager creates styles to configure representation objects and attributes of representation objects. The whole business class configuration should be implemented using the shared styles accessible through the Style Manager.

Since:

JTGO 3.0

See Also:

IlpStyleManager

Deprecated Since:

JTGO 3.5

Constructor Summary

Constructors

Constructor and Description
IlpBasicGraphicViewStyleManager(IlpContext context, IlpGraphicView graphicView) Deprecated. Creates a basic graphic view style manager, based on the given context and to be used by the given graphic view.

Method Summary

Modifier and Type	Method and Description
void	cleanup() Deprecated. Forces the Style Manager to clean up unnecessary styles, or styles that correspond to objects that are no longer needed by the application.
IlpStyleManager	getDefaultStyleManager() Deprecated. Returns the default style manager used by this configuration.
IlpStyle	getExistingStyle(IlpStyleContext styleContext) Deprecated. Gets a style by style context.
IlpStyle	getStyle() Deprecated. Returns the style specified for this view.
IlpStyle	getStyle(Class clazz) Deprecated. Gets a style by Java class.
IlpStyle	getStyle(IlpAttribute attribute) Deprecated. Gets a style by attribute.
IlpStyle	getStyle(IlpAttribute attribute, IlpClass clazz) Deprecated. Gets a style by attribute in the given class.
IlpStyle	getStyle(IlpClass clazz) Deprecated. Gets the style of an IlpClass.
IlpStyle	getStyle(IlpObject object) Deprecated. Gets a style by IlpObject.
IlpStyle	getStyle(IlpRepresentationObject ro) Deprecated. Return the correct style for this representation object.
IlpStyle	getStyle(IlpRepresentationObject ro, IlpAttribute attribute) Deprecated. Return the correct style for this representation object.
IlpStyle	getStyle(IlpStyleContext styleContext) Deprecated. Gets a style by style context.
IlpStyle	getStyle(String name) Deprecated. Gets a style by name.
List	getStyleContexts() Deprecated. Returns a list of all contexts for available styles.
IlpGraphicView	getView() Deprecated. Returns the graphic view which is using this configuration.
Collection	loadStyleModule(String name) Deprecated. Loads all styles from a module into the buffer.
void	loadStyles() Deprecated. Loads all available styles into the buffer.
protected IlpStyle	prepareCustomAttributeStyle(IlpStyleContext instanceContext) Deprecated. Prepares the style for an attribute which is only available in the graphic view.
protected IlpStyle	prepareGraphicViewStyle(IlpStyleContext instanceContext) Deprecated. Prepares the graphic view style.
protected IlpStyle	prepareROAttributeStyle(IlpStyleContext instanceContext) Deprecated. Prepares the style for an attribute in a representation object
protected IlpStyle	prepareROStyle(IlpStyleContext instanceContext) Deprecated. Prepares the representation object style.
void	recustomizeStyles() Deprecated. Updates the contents of the styles after the style sheets have changed.
boolean	removeStyle(IlpRepresentationObject ro) Deprecated. Remove an instance style from the currently buffered styles.
boolean	removeStyle(IlpStyleContext id) Deprecated. Removes a style with the given id.
void	resetStyles() Deprecated. Cleans the contents of all currently buffered styles.
void	saveStyles() Deprecated. Saves all buffered styles to the underlying storage.
void	saveStyles(File outputFile) Deprecated. Saves all buffered styles to the given underlying storage.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlpBasicGraphicViewStyleManager

public IlpBasicGraphicViewStyleManager(IlpContext context,
                                       IlpGraphicView graphicView)

Deprecated.

Creates a basic graphic view style manager, based on the given context and to be used by the given graphic view.

Parameters:

context - Context.

graphicView - Graphic view.

Method Detail

getDefaultStyleManager

public IlpStyleManager getDefaultStyleManager()

Deprecated.

Returns the default style manager used by this configuration.

Specified by:

getDefaultStyleManager in interface IlpGraphicViewStyleManager

getView

public IlpGraphicView getView()

Deprecated.

Returns the graphic view which is using this configuration.

getStyle

public IlpStyle getStyle()

Deprecated.

Returns the style specified for this view. If no style was specifically set, a default style will be returned.

Specified by:

getStyle in interface IlpGraphicViewStyleManager

Returns:

Graphic view style for this view.

getStyle

public IlpStyle getStyle(IlpRepresentationObject ro)

Deprecated.

Return the correct style for this representation object. If no style is defined for this instance, a default style will be returned.

The style created for the given representation object will contain a list of pre-defined default styles, which are listed below:

• Style for the graphic view instance
  • Style for the graphic view Java class
• Style for the corresponding business object
  • Style for the corresponding business object class

Specified by:

getStyle in interface IlpGraphicViewStyleManager

Parameters:

ro - Representation object.

Returns:

Style for given representation object.

getStyle

public IlpStyle getStyle(IlpRepresentationObject ro,
                         IlpAttribute attribute)

Deprecated.

Return the correct style for this representation object. If no style is defined for this instance, a default style will be returned.

The style created for the given attribute in the representation object contains a pre-defined default style:

• Attribute style: if this attribute is defined in the business object class; or
• Attribute value class style and
• IlpAttribute Java class style: if the attribute is not defined in a business object class.

If the attribute is not defined in a business object class, this style contains

Specified by:

getStyle in interface IlpGraphicViewStyleManager

Parameters:

ro - Representation object.

attribute - Attribute linked to representation object.

Returns:

Style for given representation object.

getStyle

public IlpStyle getStyle(String name)

Deprecated.

Gets a style by name. This method is used for named styles.

Important: Returns the shared style instance corresponding to the given name. Changing the returned style may affect your whole application.

Specified by:

getStyle in interface IlpStyleManager

Parameters:

name - The name of the style to retrieve.

Returns:

The requested style.

getStyle

public IlpStyle getStyle(IlpClass clazz)

Deprecated.

Gets the style of an IlpClass. This method is used for IlpClass styles.

Important : Returns the shared style instance which corresponds to the given business class. Changing the returned style may affect your whole application.

Specified by:

getStyle in interface IlpStyleManager

Parameters:

clazz - The IlpClass associated with the style.

Returns:

The requested style.

getStyle

public IlpStyle getStyle(IlpObject object)

Deprecated.

Gets a style by IlpObject. This method is used for IlpObject instance styles.

Important : Returns the shared style instance which corresponds to the given business object. Changing the returned style may affect all representations of the given object.

Specified by:

getStyle in interface IlpStyleManager

Parameters:

object - The IlpObject of the style.

Returns:

The requested style.

getStyle

public IlpStyle getStyle(IlpAttribute attribute)

Deprecated.

Gets a style by attribute. This method is used for attribute styles. When retrieving an attribute style, the IlpClass linked in the attribute will be used.

Important : Returns the shared style instance which corresponds to the given business attribute. Changing the returned style may affect your whole application.

Specified by:

getStyle in interface IlpStyleManager

Parameters:

attribute - The IlpAttribute of the style.

Returns:

The requested style.

getStyle

public IlpStyle getStyle(IlpAttribute attribute,
                         IlpClass clazz)

Deprecated.

Gets a style by attribute in the given class.

This method is used for attribute styles. When retrieving an attribute style, the IlpClass passed as parameter is used. The IlpClass where the attribute was initially defined must be assignable from the given IlpClass.

Important : Returns the shared style instance which corresponds to the given business attribute. Changing the returned style may affect your whole application.

Specified by:

getStyle in interface IlpStyleManager

Parameters:

attribute - The IlpAttribute of the style.

clazz - The business class where this attribute is contained.

Returns:

The requested style.

getStyle

public IlpStyle getStyle(Class clazz)

Deprecated.

Gets a style by Java class. This method is used for Java class styles.

Important : Returns the shared style instance which corresponds to the given Java class. Changing the returned style may affect your whole application.

Specified by:

getStyle in interface IlpStyleManager

Parameters:

clazz - The class of the style.

Returns:

The requested style.

resetStyles

public void resetStyles()

Deprecated.

Cleans the contents of all currently buffered styles.

Specified by:

resetStyles in interface IlpStyleManager

recustomizeStyles

public void recustomizeStyles()

Deprecated.

Updates the contents of the styles after the style sheets have changed.

Specified by:

recustomizeStyles in interface IlpStyleManager

Since:

JTGO 3.5

saveStyles

public void saveStyles()

Deprecated.

Saves all buffered styles to the underlying storage.

Internal: do not use!

saveStyles

public void saveStyles(File outputFile)

Deprecated.

Saves all buffered styles to the given underlying storage.

Internal: do not use!

loadStyles

public void loadStyles()

Deprecated.

Loads all available styles into the buffer.

Internal: do not use!

loadStyleModule

public Collection loadStyleModule(String name)

Deprecated.

Loads all styles from a module into the buffer.

Parameters:

name - Name of style module.

Returns:

collection with IlpStyleContext present in this module

Internal: do not use!

getExistingStyle

public IlpStyle getExistingStyle(IlpStyleContext styleContext)

Deprecated.

Gets a style by style context.

Specified by:

getExistingStyle in interface IlpStyleManager

Parameters:

styleContext - The style context.

Returns:

the style if it is already present in this manager or null if the style does not yet exist.

NOTE: The style returned by this method must not be modified.

cleanup

public void cleanup()

Deprecated.

Forces the Style Manager to clean up unnecessary styles, or styles that correspond to objects that are no longer needed by the application.

This method cleans up instance styles, mainly styles which are only removed when the objects are garbage collected.

Specified by:

cleanup in interface IlpStyleManager

Since:

JTGO 3.1

getStyle

public IlpStyle getStyle(IlpStyleContext styleContext)

Deprecated.

Gets a style by style context.

Specified by:

getStyle in interface IlpStyleManager

Parameters:

styleContext - The style context.

Returns:

The requested style.

Internal: do not use!

removeStyle

public boolean removeStyle(IlpRepresentationObject ro)

Deprecated.

Remove an instance style from the currently buffered styles. If a style is not removable, the method will return false.

Specified by:

removeStyle in interface IlpGraphicViewStyleManager

Parameters:

ro - The representation object that is associated to the style.

Returns:

Boolean indicating whether the style was removed.

removeStyle

public boolean removeStyle(IlpStyleContext id)

Deprecated.

Removes a style with the given id.

Specified by:

removeStyle in interface IlpStyleManager

Parameters:

id - The style context identifying the style.

Returns:

true if the style identified by the given style context has been removed.

Internal: do not use!

getStyleContexts

public List getStyleContexts()

Deprecated.

Returns a list of all contexts for available styles.

Specified by:

getStyleContexts in interface IlpStyleManager

Returns:

List of IlpStyleContexts for all available styles.

prepareROStyle

protected IlpStyle prepareROStyle(IlpStyleContext instanceContext)

Deprecated.

Prepares the representation object style.

Internal: do not use!

prepareROAttributeStyle

protected IlpStyle prepareROAttributeStyle(IlpStyleContext instanceContext)

Deprecated.

Prepares the style for an attribute in a representation object

Internal: do not use!

prepareGraphicViewStyle

protected IlpStyle prepareGraphicViewStyle(IlpStyleContext instanceContext)

Deprecated.

Prepares the graphic view style.

Internal: do not use!

prepareCustomAttributeStyle

protected IlpStyle prepareCustomAttributeStyle(IlpStyleContext instanceContext)

Deprecated.

Prepares the style for an attribute which is only available in the graphic view. The attribute is not part of a specific business class.

Internal: do not use!