ilog.cpl.equipment.renderer
Class IlpBackgroundsRenderer

java.lang.Object
  ilog.cpl.graphic.css.renderer.IlpAbstractGraphicViewRenderer
      ilog.cpl.graph.css.renderer.IlpAbstractRepresentationViewRenderer
          ilog.cpl.graph.css.renderer.IlpBackgroundsRenderer
              ilog.cpl.equipment.renderer.IlpBackgroundsRenderer

public class IlpBackgroundsRenderer
extends ilog.cpl.graph.css.renderer.IlpBackgroundsRenderer

This class gives control over the backgrounds of an IlpEquipmentView.

This class is a CSS stylable bean that can be configured via CSS. One can not only configure the background(s) to be used, but also define a background color or simply an image that is to used fill the background by repeating this image over and over again.

For more details on how to do adjust this configuration see this section of the User's Manual: Graphic Components > Equipment Component > Configuring the Equipment Component > Configuring a Equipment Component through a CSS File > The Backgrounds Rule

More complex background types can be take advantage of the XML format for backgrounds. For more details see this section of the User's Manual: Graphic Components > Equipment Component > Equipment Component Services > Background Support > Advanced > XML Background Format

Since:

JTGO 4.0

See Also:

IlpEquipmentView, IlpBackgroundCSSConfiguration, IlpBackgroundSupport

Constructor Summary

IlpBackgroundsRenderer()

Method Summary

Color	getBackgroundColor() Returns the background of the view.
String	getBackgroundPattern() Returns the location of the background pattern of the view.
IlpBackgroundSupport	getBackgroundSupport() Returns the background support object currently in use.
void	setBackgroundColor(Color bg) Changes the background of the view.
void	setBackgroundPattern(String patternLocation) Changes the background pattern of the view.

Methods inherited from class ilog.cpl.graph.css.renderer.IlpBackgroundsRenderer

getCSSID, reset

Methods inherited from class ilog.cpl.graph.css.renderer.IlpAbstractRepresentationViewRenderer

attach, getView, noteContainerAdded, noteContainerUpdated

Methods inherited from class ilog.cpl.graphic.css.renderer.IlpAbstractGraphicViewRenderer

detach, getContext, getGraphicView, isRendererEnabled, setRendererEnabled

Methods inherited from class java.lang.Object

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

Constructor Detail

IlpBackgroundsRenderer

public IlpBackgroundsRenderer()

Method Detail

getBackgroundSupport

public IlpBackgroundSupport getBackgroundSupport()

Returns the background support object currently in use.

Overrides:

getBackgroundSupport in class ilog.cpl.graph.css.renderer.IlpBackgroundsRenderer

getBackgroundColor

public Color getBackgroundColor()

Returns the background of the view.

Note that there is no point in changing the background of the view if the view is transparent or if the view has a defined background pattern.

Overrides:

getBackgroundColor in class ilog.cpl.graph.css.renderer.IlpBackgroundsRenderer

Returns:

The background color.

Since:

JTGO 4.0

See Also:

getBackgroundPattern()

setBackgroundColor

public void setBackgroundColor(Color bg)

Changes the background of the view.

Note that changing the background of the view may be useless if the view is transparent or if the view has a background pattern defined.

Overrides:

setBackgroundColor in class ilog.cpl.graph.css.renderer.IlpBackgroundsRenderer

Parameters:

bg - The background color.

Since:

JTGO 4.0

getBackgroundPattern

public String getBackgroundPattern()

Returns the location of the background pattern of the view.

The background pattern is an image that is used to fill the background of the view.

This method may return null if the view has no background pattern.

Overrides:

getBackgroundPattern in class ilog.cpl.graph.css.renderer.IlpBackgroundsRenderer

Returns:

Background pattern location

Since:

JTGO 4.0

setBackgroundPattern

public void setBackgroundPattern(String patternLocation)

Changes the background pattern of the view.

The background pattern is an image that is used to fill the background of the view.

Overrides:

setBackgroundPattern in class ilog.cpl.graph.css.renderer.IlpBackgroundsRenderer

Parameters:

patternLocation - The URL of the image, or null to remove the pattern.