psdi.webclient.applet.wfcanvas.diagram

Class DiagramLineChannel

java.lang.Object

psdi.webclient.applet.wfcanvas.diagram.DiagramLineChannel

public class DiagramLineChannel
extends java.lang.Object

This class holds a line channel. This is all the relationships to plotted in a vertical or horizontal channel

Field Summary

Fields

Modifier and Type	Field and Description
static int	ABOVE Above the row
static int	AFTER After the column
static int	BEFORE Before the column
static int	BELOW Below the row
static int	HORIZONTAL The horizontal orientation
static int	LINE_WIDTH Line width
static int	VERTICAL The vertical orientation

Constructor Summary

Constructors

Constructor and Description
DiagramLineChannel(int index, int orientation, int position) Constrcust a channel

Method Summary

Modifier and Type	Method and Description
void	addWorkflowRelationship(DiagramWorkflowRelationship rel) Adds a relationship to the channel
int	getIndex() Returns the index of the channel this is the row/column that the channel is associated with
java.lang.Object	getKey() Generates a unique key for this channel object
static java.lang.Object	getKey(int index, int orientation, int position) Generates a key for a channel object which is unique for the channel parameters
int	getLineCount() Returns the count of the lines in the channel
int	getLineSpacing() Gets the line spacing
int	getLocation() Returns the location of the channel.
int	getLocation(DiagramWorkflowRelationship rel) Returns the location of the relationship that belongs to the channel.This is y coordinate for horizontal channels and the x coordinate for vertical channels
int	getOrientation() Returns the orientation of the channel
int	getPosition() Returns the channel position
int	getSpaceRequired() Returns the space required to display the channel.
java.util.Vector	getWorkflowRelationships() Returns the list of relationships in the channel
void	setLineSpacing(int spacing) Sets the line spacing
void	setLocation(int location) Sets the location of the start of the channel
java.lang.String	toString() Returns the string representation of the line channel

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

VERTICAL

public static final int VERTICAL

The vertical orientation

See Also:

Constant Field Values

HORIZONTAL

public static final int HORIZONTAL

The horizontal orientation

See Also:

Constant Field Values

ABOVE

public static final int ABOVE

Above the row

See Also:

Constant Field Values

BELOW

public static final int BELOW

Below the row

See Also:

Constant Field Values

BEFORE

public static final int BEFORE

Before the column

See Also:

Constant Field Values

AFTER

public static final int AFTER

After the column

See Also:

Constant Field Values

LINE_WIDTH

public static final int LINE_WIDTH

Line width

See Also:

Constant Field Values

Constructor Detail

DiagramLineChannel

public DiagramLineChannel(int index,
                          int orientation,
                          int position)

Constrcust a channel

Parameters:

index - The index of the channel - row/column

orientation - The orientation - HORIZONTAL/VERTICAL

position - The position - ABOVE/BELOW/BEFORE/AFTER

Method Detail

getIndex

public int getIndex()

Returns the index of the channel this is the row/column that the channel is associated with

Returns:

The index

getOrientation

public int getOrientation()

Returns the orientation of the channel

Returns:

The orientation - HORIZONTAL/VERTICAL

getPosition

public int getPosition()

Returns the channel position

Returns:

The position - ABOVE/BELOW/BEFORE/AFTER

addWorkflowRelationship

public void addWorkflowRelationship(DiagramWorkflowRelationship rel)

Adds a relationship to the channel

Parameters:

rel - The relationship to add

getWorkflowRelationships

public java.util.Vector getWorkflowRelationships()

Returns the list of relationships in the channel

Returns:

The relationships

getKey

public java.lang.Object getKey()

Generates a unique key for this channel object

Returns:

The key

getLineCount

public int getLineCount()

Returns the count of the lines in the channel

Returns:

The line count

getSpaceRequired

public int getSpaceRequired()

Returns the space required to display the channel. This is the height for horizontal channels or the with for vertical channels

Returns:

The space required in pixels

getLocation

public int getLocation()

Returns the location of the channel. This is y coordinate for horizontal channels and the x coordinate for vertical channels

Returns:

The channel position

getLocation

public int getLocation(DiagramWorkflowRelationship rel)

Returns the location of the relationship that belongs to the channel.This is y coordinate for horizontal channels and the x coordinate for vertical channels

Parameters:

rel - The relationship to get position for

Returns:

The relationship position

setLocation

public void setLocation(int location)

Sets the location of the start of the channel

Parameters:

location - The starting location

setLineSpacing

public void setLineSpacing(int spacing)

Sets the line spacing

Parameters:

spacing - The line spacing

getLineSpacing

public int getLineSpacing()

Gets the line spacing

Returns:

The line spacing

toString

public java.lang.String toString()

Returns the string representation of the line channel

Overrides:

toString in class java.lang.Object

Returns:

The string representation

getKey

public static java.lang.Object getKey(int index,
                                      int orientation,
                                      int position)

Generates a key for a channel object which is unique for the channel parameters

Parameters:

index - The channel index - this is the row/column

orientation - The orientation - VERTICAL/HORIZONTAL

position - The position - ABOVE/BELOW/BEFORE/AFTER

Returns:

The key