Class Viewer.Presentation.PresentationStateGraphicLayer
All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class Viewer.Presentation.PresentationStateGraphicLayer

Object
   |
   +----Viewer.Presentation.PresentationStateGraphicLayer

public class PresentationStateGraphicLayer
extends Object
This class manages the layer of a presentation state.

Author:
Klaus Kleber
Since:
30.04.1999

Variable Index

 o color
Contains the current Color
 o listPresentationStateObject
Contains a list of all PresentationStateLayerObjects.

Constructor Index

 o Viewer.Presentation.PresentationStateGraphicLayer(int, jDVPresentationState, double, double, OverlayList)
Constructs a new object form the specified jDVPresentationState.
 o Viewer.Presentation.PresentationStateGraphicLayer(int, jDVPresentationState, double, double, String, String, float, OverlayList)
Constructs a object form the specified parameters and insert a new layer with monochome Colors to the jDVPresentationState.
 o Viewer.Presentation.PresentationStateGraphicLayer(int, jDVPresentationState, double, double, String, String, int, int, int, OverlayList)
Constructs a object form the specified parameters and insert a new layer with rgb Colors to the jDVPresentationState.

Method Index

 o add(PresentationStateLayerObject)
Adds the specified PresentationStateLayerObject to this PresentationStateGraphicLayer
 o containsLayerObject(Point2D. Float)
Search and returns the first PresentationStateLayerObject that contains the specified point.
 o deleteAll()
Deletes all objects of the PresentationStateGraphicLayer.
 o deleteObjectAt(int)
Deletes the PresentationStateLayerObject with the specified index form the jDVPresentationState object and the PresentationStateGraphicLayer
 o draw(Graphics2D, AffineTransform, AffineTransform)
Draws all PresentationStateLayerObject and all overlays after the specified transformation aff in the specified Graphics2 context.
 o getBlue()
Returns the blue value of the recommended display value
 o getColor()
Gets the color for the recommended display value of the layer.
 o getDescription()
Gets the description of the graphic layer.
 o getFloatGrayColorValue()
Gets a transformed grey color value between 0 and 1 of the recommended display value.
 o getGreen()
Returns the green value of the recommended display value
 o getInfo()
Returns a String representing this object.
 o getName()
Gets the unique name of the graphic layer.
 o getRed()
Returns the red value of the recommended display value
 o haveGraphicLayerRecommendedDisplayValue()
Checks whether a recommended display value for the given graphic layer exists.
 o isGray()
Checks if the recommended display value is a gray value.
 o layerObjectAt(int)
Returns the PresentationStateLayerObject at the specified index.
 o removeObjectAt(int)
Removes the PresentationStateLayerObject with the specified index form this PresentationStateGraphicLayer.
 o setDescription(String)
Sets the description of the layer.
 o setFloatColorValue(float)
Sets the recommended display value as a value between 0 and 1.
 o setGraphicLayerRecommendedDisplayValueGray(int)
Sets the monochrome recommended display value of the layer.
 o setGraphicLayerRecommendedDisplayValueRGB(int, int, int)
Sets the RGB recommended display value of the layer.
 o setNewGraphicIndex(int)
Reduces the index of all PresentationStateGraphicObject where the index in the listPresentationStateObject is greather than the specified delIndex.
 o setNewName(String)
Sets the name of the layer.
 o setNewTextIndex(int)
Reduces the attribut index of all PresentationStateTextObject where the index in the listPresentationStateObject is greather than the specified delIndex.
 o setScreenSize(Dimension)
Sets the size for displaying the image in all PresentationStateLayerObjects of the PresentationStateGraphicLayer.

Variables

 o color
public java.awt.Color color
Contains the current Color

Since: 30.04.1999
 o listPresentationStateObject
public java.util.Vector listPresentationStateObject
Contains a list of all PresentationStateLayerObjects.

Since: 30.04.1999

Constructors

 o PresentationStateGraphicLayer
public PresentationStateGraphicLayer(int index,
                                     jDVPresentationState ps,
                                     double scalingX,
                                     double scalingY,
                                     OverlayList overlayList)
Constructs a new object form the specified jDVPresentationState. The specified index is the index of the building graphic layer in the jDVPresentationState. listPresentationStateObject will be filled with the annotations in the layer.

Parameters:
index - Contains the index of the new object.
ps - Contains the current jDVPresentationState.
scalingX - Contains the vertical scaling value.
scalingY - Contains the horizontal scaling value.
overlayList - Contains all overlays.
Since:
30.04.1999
 o PresentationStateGraphicLayer
public PresentationStateGraphicLayer(int index,
                                     jDVPresentationState ps,
                                     double scalingX,
                                     double scalingY,
                                     String name,
                                     String description,
                                     float monochrome,
                                     OverlayList overlayList)
Constructs a object form the specified parameters and insert a new layer with monochome Colors to the jDVPresentationState.

Parameters:
index - The new index of the new Object and the index of the new layer in the jDVPresentationState.
ps - Contains the current jDVPresentationState.
scalingX - Contains the vertical scaling value.
scalingY - Contains the horizontal scaling value.
name - Contains the name of the new layer
description - Contains the description of the new layer.
monochrome - Contains the gray color value of the new layer
overlayList - Contains all overlays.
Since:
30.04.1999
 o PresentationStateGraphicLayer
public PresentationStateGraphicLayer(int index,
                                     jDVPresentationState ps,
                                     double scalingX,
                                     double scalingY,
                                     String name,
                                     String description,
                                     int r,
                                     int g,
                                     int b,
                                     OverlayList overlayList)
Constructs a object form the specified parameters and insert a new layer with rgb Colors to the jDVPresentationState.

Parameters:
index - The new index of the new Object and the index of the new layer in the jDVPresentationState.
ps - Contains the current jDVPresentationState.
scalingX - Contains the vertical scaling value.
scalingY - Contains the horizontal scaling value.
name - Contains the name of the new layer
description - Contains the description of the new layer.
r - Contains the red color value of the new layer
g - Contains the green color value of the new layer
b - Contains the blue color value of the new layer
overlayList - Contains all overlays.
Since:
30.04.1999

Methods

 o add
public void add(PresentationStateLayerObject addPresentationStateLayerObject)
Adds the specified PresentationStateLayerObject to this PresentationStateGraphicLayer

Parameters:
addPresentationStateLayerObject - The new PresentationStateLayerObject.
Since:
30.04.1999
 o containsLayerObject
public int containsLayerObject(Point2D.Float point)
Search and returns the first PresentationStateLayerObject that contains the specified point. Returns null if there is no such PresentationStateLayerObject.

Parameters:
point - The specified point.
Returns:
The first PresentationStateLayerObject that contains the specified point. Returns null
Since:
30.04.1999
 o deleteAll
public void deleteAll()
Deletes all objects of the PresentationStateGraphicLayer.

Since:
30.04.1999
 o deleteObjectAt
public void deleteObjectAt(int deleteIndex)
Deletes the PresentationStateLayerObject with the specified index form the jDVPresentationState object and the PresentationStateGraphicLayer

Parameters:
deleteIndex - The index of the PresentationStateLayerObject in the listPresentationStateObject.
Since:
30.04.1999
See Also:
removeGraphicObject, removeTextObject
 o draw
public void draw(Graphics2D g,
                 AffineTransform aff,
                 AffineTransform overlayAff)
Draws all PresentationStateLayerObject and all overlays after the specified transformation aff in the specified Graphics2 context.

Parameters:
g - The context in wich the image will be drawn.
aff - The transformation which will be applied befor drawing.
aff - Specifies the transformation which will be used for PresentationStateOverlayObjects.
Since:
30.04.1999
 o getBlue
public int getBlue()
Returns the blue value of the recommended display value

Returns:
Returns the blue value of the recommended display value.
Since:
30.04.1999
 o getColor
public java.awt.Color getColor()
Gets the color for the recommended display value of the layer.

Returns:
Color for the recommended display value of the layer.
Since:
30.04.1999
See Also:
jDVPresentationState
 o getDescription
public java.lang.String getDescription()
Gets the description of the graphic layer.

Returns:
Description of the graphic layer.
Since:
30.04.1999
See Also:
getGraphicLayerDescription
 o getFloatGrayColorValue
public float getFloatGrayColorValue()
Gets a transformed grey color value between 0 and 1 of the recommended display value. The recommended display value have values between 0 and 0xffff. This function returns this value divide to 0xffff.

Returns:
Gets a grey color value between 0 and 1.
Since:
30.04.1999
See Also:
getGraphicLayerRecommendedDisplayValueGray
 o getGreen
public int getGreen()
Returns the green value of the recommended display value

Returns:
Returns the green value of the recommended display value.
Since:
30.04.1999
 o getInfo
public java.lang.String getInfo()
Returns a String representing this object.

Returns:
A String representing this object
Since:
30.04.1999
 o getName
public java.lang.String getName()
Gets the unique name of the graphic layer.

Returns:
Unique name of the graphic layer.
Since:
30.04.1999
See Also:
getGraphicLayerName
 o getRed
public int getRed()
Returns the red value of the recommended display value

Returns:
Returns the red value of the recommended display value.
Since:
30.04.1999
 o haveGraphicLayerRecommendedDisplayValue
public boolean haveGraphicLayerRecommendedDisplayValue()
Checks whether a recommended display value for the given graphic layer exists.

Parameters:
idx - index of the graphic layer, must be < getNumberOfGraphicLayers()
Returns:
true if a recommended display value exists
Since:
30.04.1999
See Also:
haveGraphicLayerRecommendedDisplayValue
 o isGray
public boolean isGray()
Checks if the recommended display value is a gray value.

Returns:
Returns true, if the recommended display value is a gray value.
Since:
30.04.1999
See Also:
isGrayGraphicLayerRecommendedDisplayValue
 o layerObjectAt
public Viewer.Presentation.PresentationStateLayerObject layerObjectAt(int index)
Returns the PresentationStateLayerObject at the specified index. Returns null if there is no such PresentationStateLayerObject.

Parameters:
index - The index specified the PresentationStateLayerObject
Returns:
The PresentationStateLayerObject at the specified index.
Since:
30.04.1999
 o removeObjectAt
public void removeObjectAt(int deleteIndex)
Removes the PresentationStateLayerObject with the specified index form this PresentationStateGraphicLayer.

Parameters:
deleteIndex - The index of the PresentationStateLayerObject in the listPresentationStateObject.
Since:
30.04.1999
 o setDescription
public void setDescription(String newDescription)
Sets the description of the layer. The value is stored in the c++ interface and is available in the jDVPresententationState object ps.

Parameters:
newDescription - The description of the layer.
Since:
30.04.1999
See Also:
setGraphicLayerDescription
 o setFloatColorValue
public void setFloatColorValue(float colorValue)
Sets the recommended display value as a value between 0 and 1. The recommended display value have values between 0 and 0xffff. This function mulipies the specified value with 0xffff and sets these value as recommeded display value of the gaphic layer.

Parameters:
colorValue - Contains the recommended display value as a value between 0 and 1.
Since:
30.04.1999
See Also:
setGraphicLayerRecommendedDisplayValueGray
 o setGraphicLayerRecommendedDisplayValueGray
public void setGraphicLayerRecommendedDisplayValueGray(int color)
Sets the monochrome recommended display value of the layer. The value is stored in the c++ interface and is available in the jDVPresententationState object ps.

Parameters:
color - The monchrome color of the layer.
Since:
30.04.1999
See Also:
setGraphicLayerRecommendedDisplayValueGray
 o setGraphicLayerRecommendedDisplayValueRGB
public void setGraphicLayerRecommendedDisplayValueRGB(int r,
                                                      int g,
                                                      int b)
Sets the RGB recommended display value of the layer. The value is stored in the c++ interface and is available in the jDVPresententationState object ps.

Parameters:
color - The RGB color of the layer.
Since:
30.04.1999
See Also:
setGraphicLayerRecommendedDisplayValueRGB
 o setNewGraphicIndex
public void setNewGraphicIndex(int delIndex)
Reduces the index of all PresentationStateGraphicObject where the index in the listPresentationStateObject is greather than the specified delIndex.

Parameters:
delIndex - Specified the deleted index.
Since:
30.04.1999
 o setNewName
public boolean setNewName(String newName)
Sets the name of the layer. The value is stored in the c++ interface and is available in the jDVPresententationState object ps.

Parameters:
newName - The name of the layer.
Since:
30.04.1999
See Also:
setGraphicLayerName
 o setNewTextIndex
public void setNewTextIndex(int delIndex)
Reduces the attribut index of all PresentationStateTextObject where the index in the listPresentationStateObject is greather than the specified delIndex.

Parameters:
delIndex - Specifies the deleted index
Since:
30.04.1999
 o setScreenSize
public void setScreenSize(Dimension screenSize)
Sets the size for displaying the image in all PresentationStateLayerObjects of the PresentationStateGraphicLayer. This vlaue will be used for calulating the display relative annotations.

Parameters:
screenSize - The size for displaying the image
Since:
30.04.1999

All Packages  Class Hierarchy  This Package  Previous  Next  Index