ilog.tgo.graphic.renderer

Class IltAbstractImageBaseRendererFactory

java.lang.Object

ilog.tgo.graphic.renderer.IltAbstractImageBaseRendererFactory

All Implemented Interfaces:

IltBaseRendererFactory

Direct Known Subclasses:

IltCardImageBaseRendererFactory, IltLogicalImageBaseRendererFactory, IltNEImageBaseRendererFactory, IltOPCImageBaseRendererFactory, IltPortImageBaseRendererFactory, IltTinyImageBaseRendererFactory

public abstract class IltAbstractImageBaseRendererFactory
extends Object
implements IltBaseRendererFactory

Abstract implementation for factories that create base renderers displaying images.

This factory can customize two characteristics of the base renderer:

• Polygonal borders: indicates if the alarm and selection border should be displayed as a polygon around the base.
• Dotted border: indicates if a dotted border shall be displayed or not around the base. Please note that dotted border cannot be applied to polygonal border.

Since:

JTGO 4.0

See Also:

IltBaseRenderer, IltBaseRendererFactory, IltSettings

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IltAbstractImageBaseRendererFactory() Default constructor
protected	IltAbstractImageBaseRendererFactory(Image sourceImage) Creates a new IltImageCardBaseRendererFactory.
protected	IltAbstractImageBaseRendererFactory(Image sourceImage, int brightThreshold, int darkThreshold, int normGray) Creates a new IltImageCardBaseRendererFactory.
protected	IltAbstractImageBaseRendererFactory(Image sourceImage, int brightThreshold, int darkThreshold, int normGray, boolean dottedBorderVisible) Creates a new IltImageCardBaseRendererFactory.
protected	IltAbstractImageBaseRendererFactory(String sourceImageName, int brightThreshold, int darkThreshold, int normGray, boolean dottedBorderVisible) Creates a new IltImageCardBaseRendererFactory.

Method Summary

Modifier and Type	Method and Description
protected abstract IltBaseRenderer	createBaseRenderer() This method can be overridden to create the real base renderer that displays the image.
IltBaseRenderer	createValue() Creates a new renderer with the current image configuration.
int	getBrightThreshold() Returns the threshold (0..255) used for bright colors when computing the NoTraffic representation.
int	getDarkThreshold() Returns the threshold (0..255) applied to dark colors when computing the NoTraffic representation.
int	getGrayLevel() Returns the gray level (0..255) applied when computing the alarm CarryingTraffic representation.
ilog.tgo.graphic.renderer.internal.IltImageBaseRendererFactory	getImageFactory() Returns the internal factory responsible for rendering the image.
Image	getSourceImage() Returns the image to be processed to create the different BaseStyle representations.
String	getSourceImageName() Returns the image to be processed to create the different BaseStyle representations.
boolean	isDottedBorderVisible() Indicates whether an additional dotted border should be drawn around the base.
boolean	isPolygonalBorder() Indicates whether the alarm and selection borders should be drawn with a polygon that follows the border of the image.
void	setBrightThreshold(int threshold) Sets the threshold (0..255) used for bright colors when computing the NoTraffic representation.
void	setDarkThreshold(int threshold) Sets the threshold (0..255) applied to dark colors when computing the NoTraffic representation.
void	setDottedBorderVisible(boolean dottedBorderVisible) Indicates whether an additional dotted border should be drawn around the base.
void	setGrayLevel(int level) Sets the gray level (0..255) applied when computing the alarm CarryingTraffic representation.
void	setPolygonalBorder(boolean polygonalBorder) Indicates whether the alarm and selection borders should be drawn with a polygon that follows the border of the image.
void	setSourceImage(Image img) Sets the image to be processed to create the different BaseStyle representations.
void	setSourceImageName(String imgName) Sets the image to be processed to create the different BaseStyle representations.

Methods inherited from class java.lang.Object

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

Constructor Detail

IltAbstractImageBaseRendererFactory

protected IltAbstractImageBaseRendererFactory(Image sourceImage,
                                              int brightThreshold,
                                              int darkThreshold,
                                              int normGray)

Creates a new IltImageCardBaseRendererFactory.

Parameters:

sourceImage - The image to be processed to create the different BaseStyle representations.

brightThreshold - The threshold (0..255) applied to bright colors when computing the NoTraffic representation.

darkThreshold - The threshold (0..255) applied to dark colors when computing the NoTraffic representation.

normGray - The gray level (0..255) applied when computing the alarm CarryingTraffic representation.

IltAbstractImageBaseRendererFactory

protected IltAbstractImageBaseRendererFactory(Image sourceImage,
                                              int brightThreshold,
                                              int darkThreshold,
                                              int normGray,
                                              boolean dottedBorderVisible)

Creates a new IltImageCardBaseRendererFactory.

Parameters:

sourceImage - The image to be processed to create the different BaseStyle representations.

brightThreshold - The threshold (0..255) applied to bright colors when computing the NoTraffic representation.

darkThreshold - The threshold (0..255) applied to dark colors when computing the NoTraffic representation.

normGray - The gray level (0..255) applied when computing the alarm CarryingTraffic representation.

dottedBorderVisible - Indicates whether an additional dotted border is to be drawn around the base.

See Also:

IltBaseRenderer.isDottedBorderVisible()

IltAbstractImageBaseRendererFactory

protected IltAbstractImageBaseRendererFactory(String sourceImageName,
                                              int brightThreshold,
                                              int darkThreshold,
                                              int normGray,
                                              boolean dottedBorderVisible)

Creates a new IltImageCardBaseRendererFactory.

Parameters:

sourceImageName - the image that will be processed to create the different BaseStyle representations.

brightThreshold - the threshold (0..255) used for bright colors when computing the NoTraffic representation.

darkThreshold - the threshold (0..255) used for dark colors when computing the NoTraffic representation.

normGray - the gray level (0..255) used when computing the alarmed CarryingTraffic representation.

dottedBorderVisible - indicates if an additional dotted border should be drawn around the base.

See Also:

IltBaseRenderer.isDottedBorderVisible()

IltAbstractImageBaseRendererFactory

protected IltAbstractImageBaseRendererFactory()

Default constructor

Since:

JViews 7.5

IltAbstractImageBaseRendererFactory

protected IltAbstractImageBaseRendererFactory(Image sourceImage)

Creates a new IltImageCardBaseRendererFactory.

Using this constructor is equivalent to IltImageCardBaseRendererFactory(sourceImage,200,50,128,false).

Method Detail

getImageFactory

public ilog.tgo.graphic.renderer.internal.IltImageBaseRendererFactory getImageFactory()

Returns the internal factory responsible for rendering the image.

Internal: do not use!

createBaseRenderer

protected abstract IltBaseRenderer createBaseRenderer()

This method can be overridden to create the real base renderer that displays the image.

This method is called by createValue().

setSourceImage

public final void setSourceImage(Image img)

Sets the image to be processed to create the different BaseStyle representations.

The source image must be specified before using this renderer factory. Once the renderer factory is in use, modifying the source image has no effect on the object representation.

Parameters:

img - Source image

Since:

JViews 7.5

getSourceImage

public final Image getSourceImage()

Returns the image to be processed to create the different BaseStyle representations.

Returns:

Source image

Since:

JViews 7.5

setSourceImageName

public final void setSourceImageName(String imgName)

Sets the image to be processed to create the different BaseStyle representations.

The source image must be specified before using this renderer factory. Once the renderer factory is in use, modifying the source image has no effect on the object representation.

Parameters:

imgName - Source image name

Since:

JViews 7.5

getSourceImageName

public final String getSourceImageName()

Returns the image to be processed to create the different BaseStyle representations.

Returns:

Source image name

Since:

JViews 7.5

setBrightThreshold

public final void setBrightThreshold(int threshold)

Sets the threshold (0..255) used for bright colors when computing the NoTraffic representation.

The bright color threshold can be specified before using this renderer factory. Once the renderer factory is in use, modifying the threshold has no effect on the object representation.

Parameters:

threshold - Bright color threshold

Since:

JViews 7.5

getBrightThreshold

public final int getBrightThreshold()

Returns the threshold (0..255) used for bright colors when computing the NoTraffic representation.

Returns:

Bright color threshold

Since:

JViews 7.5

setDarkThreshold

public final void setDarkThreshold(int threshold)

Sets the threshold (0..255) applied to dark colors when computing the NoTraffic representation.

The dark color threshold can be specified before using this renderer factory. Once the renderer factory is in use, modifying the threshold has no effect on the object representation.

Parameters:

threshold - Dark threshold level

Since:

JViews 7.5

getDarkThreshold

public final int getDarkThreshold()

Returns the threshold (0..255) applied to dark colors when computing the NoTraffic representation.

Returns:

Dark threshold level

Since:

JViews 7.5

setGrayLevel

public final void setGrayLevel(int level)

Sets the gray level (0..255) applied when computing the alarm CarryingTraffic representation.

The gray level can be specified before using this renderer factory. Once the renderer factory is in use, modifying the level has no effect on the object representation.

Parameters:

level - Gray level

Since:

JViews 7.5

getGrayLevel

public final int getGrayLevel()

Returns the gray level (0..255) applied when computing the alarm CarryingTraffic representation.

Returns:

Gray level

Since:

JViews 7.5

setDottedBorderVisible

public final void setDottedBorderVisible(boolean dottedBorderVisible)

Indicates whether an additional dotted border should be drawn around the base.

The default value is false.

Note: A dotted border cannot be applied to a polygonal border.

See Also:

IltBaseRenderer.isDottedBorderVisible()

isDottedBorderVisible

public final boolean isDottedBorderVisible()

Indicates whether an additional dotted border should be drawn around the base.

The default value is false.

Note: A dotted border cannot be applied to a polygonal border.

See Also:

IltBaseRenderer.isDottedBorderVisible()

setPolygonalBorder

public final void setPolygonalBorder(boolean polygonalBorder)

Indicates whether the alarm and selection borders should be drawn with a polygon that follows the border of the image. If false, the borders are drawn as rectangles.

The default value is false.

Note: A dotted border cannot be applied to a polygonal border.

See Also:

IltBaseRenderer.getExtraBorders(ilog.views.IlvRect)

isPolygonalBorder

public final boolean isPolygonalBorder()

Indicates whether the alarm and selection borders should be drawn with a polygon that follows the border of the image. If false, the borders are drawn as rectangles.

The default value is false.

Note: A dotted border cannot be applied to a polygonal border.

See Also:

IltBaseRenderer.getExtraBorders(ilog.views.IlvRect)

createValue

public IltBaseRenderer createValue()

Creates a new renderer with the current image configuration.

Specified by:

createValue in interface IltBaseRendererFactory

Returns:

the created IltBaseRenderer

See Also:

IltSettings.SetValue(java.lang.Object, java.lang.Object), IltBaseRenderer