Class ViewSettings

java.lang.Object
   |
   +----ViewSettings

public class ViewSettings
extends Object
Class definition for user-configurable view settings.

Version:
$Revision: 1.6 $, $Date: 2000/10/30 17:03:30 $
Author:
John Cavanaugh

Variable Index

 o areaBounds
A flag indicating whether area boundaries are to be displayed.
 o areaLabels
A flag indicating whether area labels are to be displayed.
 o COLOR_VCC_BY_AGE
 o COLOR_VCC_BY_MAX
 o COLOR_VCC_BY_MIN
 o COLOR_VCC_BY_OWNER
 o COLOR_VCC_BY_RATE
 o COLOR_VCC_BY_SIG
 o colorVCCBy
A selector indicating how VCC colors are to be chosen.
 o displaySize
The size of the display window.
 o DRAW_VCC_AS_ARC
 o DRAW_VCC_AS_LINE
 o DRAW_VCC_AS_MAX
 o DRAW_VCC_AS_MIN
 o drawVCCAs
A selector indicating how VCCs are to be drawn.
 o hostLabels
A flag indicating whether end system labels are to be displayed.
 o orphans
A flag indicating whether orphan hosts are to be displayed.
 o switchLabels
A flag indicating whether switch labels are to be displayed.
 o switchLinks
A flag indicating whether switch-switch links are to be displayed.
 o vccOwner
An array of flags indicating whether VCCs of each different owner are to be displayed.
 o vccOwnerColors
An array of colors for VCCs of each different owenr.
 o VCCs
A flag indicating whether VCCs are to be displayed.
 o vccSig
An array of flags indicating whether VCCs of each signalling protocol type are to be displayed.
 o vccSigColors
An array of colors for VCCs of each signalling protocol type.

Constructor Index

 o ViewSettings()
Constructs a ViewSettings object with default values.

Method Index

 o getColorVCCBy()
Gets the method for choosing VCC colors.
 o getDisplaySize()
Gets the display window size.
 o getDrawVCCAs()
Gets the method for drawing VCCs.
 o getVCCOwner()
Gets the array of VCC owner settings.
 o getVCCOwnerColor(int)
Gets VCC color by owner.
 o getVCCOwnerColors()
Gets the array of VCC owner colors.
 o getVCCSigColor(int)
Gets the VCC color by signalling type.
 o getVCCSigColors()
Gets the array of VCC signalling protocol colors.
 o getVCCSigTypes()
Gets the array of VCC visibility settings.
 o setAreaBounds(boolean)
Sets area bounds visibility.
 o setAreaLabels(boolean)
Sets area label visibility.
 o setColorVCCBy(int)
Sets the method for choosing VCC colors.
 o setDisplaySize(Dimension)
Sets the display window size.
 o setDrawVCCAs(int)
Sets the method for drawing VCCs.
 o setHostLabels(boolean)
Sets host label visibility.
 o setOrphans(boolean)
Sets orphan host visibility.
 o setSwitchLabels(boolean)
Sets switch label visibility.
 o setSwitchLinks(boolean)
Sets switch link visibility.
 o setVCCOwner(int, boolean)
Sets VCC visibility by owner.
 o setVCCs(boolean)
Sets VCC visibility.
 o setVCCSigType(int, boolean)
Sets VCC visibility by signalling type.
 o showAreaBounds()
Returns area bounds visibility.
 o showAreaLabels()
Returns area label visibility.
 o showHostLabels()
Returns host label visibility.
 o showOrphans()
Returns orphan host visibility.
 o showSwitchLabels()
Returns switch label visibility.
 o showSwitchLinks()
Returns switch link visibility.
 o showVCCOwner(int)
Returns VCC visibility by owner.
 o showVCCs()
Returns VCC visibility.
 o showVCCSigType(int)
Returns VCC visibility by signalling type.
 o toString()
Gets a string describing the view settings.

Variables

 o displaySize
 private Dimension displaySize
The size of the display window.

 o hostLabels
 private boolean hostLabels
A flag indicating whether end system labels are to be displayed.

 o switchLabels
 private boolean switchLabels
A flag indicating whether switch labels are to be displayed.

 o orphans
 private boolean orphans
A flag indicating whether orphan hosts are to be displayed.

 o areaBounds
 private boolean areaBounds
A flag indicating whether area boundaries are to be displayed.

 o areaLabels
 private boolean areaLabels
A flag indicating whether area labels are to be displayed.

 o switchLinks
 private boolean switchLinks
A flag indicating whether switch-switch links are to be displayed.

 o VCCs
 private boolean VCCs
A flag indicating whether VCCs are to be displayed.

 o vccSig
 private boolean vccSig[]
An array of flags indicating whether VCCs of each signalling protocol type are to be displayed.

 o vccSigColors
 private Color vccSigColors[]
An array of colors for VCCs of each signalling protocol type.

 o vccOwner
 private boolean vccOwner[]
An array of flags indicating whether VCCs of each different owner are to be displayed.

 o vccOwnerColors
 private Color vccOwnerColors[]
An array of colors for VCCs of each different owenr.

 o colorVCCBy
 private int colorVCCBy
A selector indicating how VCC colors are to be chosen.

 o COLOR_VCC_BY_SIG
 public static final int COLOR_VCC_BY_SIG
 o COLOR_VCC_BY_OWNER
 public static final int COLOR_VCC_BY_OWNER
 o COLOR_VCC_BY_RATE
 public static final int COLOR_VCC_BY_RATE
 o COLOR_VCC_BY_AGE
 public static final int COLOR_VCC_BY_AGE
 o COLOR_VCC_BY_MIN
 public static final int COLOR_VCC_BY_MIN
 o COLOR_VCC_BY_MAX
 public static final int COLOR_VCC_BY_MAX
 o drawVCCAs
 private int drawVCCAs
A selector indicating how VCCs are to be drawn.

 o DRAW_VCC_AS_LINE
 public static final int DRAW_VCC_AS_LINE
 o DRAW_VCC_AS_ARC
 public static final int DRAW_VCC_AS_ARC
 o DRAW_VCC_AS_MIN
 public static final int DRAW_VCC_AS_MIN
 o DRAW_VCC_AS_MAX
 public static final int DRAW_VCC_AS_MAX

Constructors

 o ViewSettings
 public ViewSettings()
Constructs a ViewSettings object with default values.

Methods

 o getDisplaySize
 public Dimension getDisplaySize()
Gets the display window size.

Returns:
a Dimension giving the size of the display window.
 o setDisplaySize
 public void setDisplaySize(Dimension displaySize)
Sets the display window size.

Parameters:
displaySize - the size of the display window.
 o showHostLabels
 public boolean showHostLabels()
Returns host label visibility.

Returns:
true if host labels are to be displayed; false otherwise.
 o setHostLabels
 public void setHostLabels(boolean hostLabels)
Sets host label visibility.

Parameters:
hostLabels - true if host labels are to be displayed; false otherwise.
 o showSwitchLabels
 public boolean showSwitchLabels()
Returns switch label visibility.

Returns:
true if switch labels are to be displayed; false otherwise.
 o setSwitchLabels
 public void setSwitchLabels(boolean switchLabels)
Sets switch label visibility.

Parameters:
switchLabels - true if switch labels are to be displayed; false otherwise.
 o showOrphans
 public boolean showOrphans()
Returns orphan host visibility.

Returns:
true if orphan hosts are to be displayed; false otherwise.
 o setOrphans
 public void setOrphans(boolean orphans)
Sets orphan host visibility.

Parameters:
orphans - true if orphan hosts are to be displayed; false otherwise.
 o showAreaBounds
 public boolean showAreaBounds()
Returns area bounds visibility.

Returns:
true if area boundaries are to be displayed; false otherwise.
 o setAreaBounds
 public void setAreaBounds(boolean areaBounds)
Sets area bounds visibility.

Parameters:
areaBounds - true if area boundaries are to be displayed; false otherwise.
 o showAreaLabels
 public boolean showAreaLabels()
Returns area label visibility.

Returns:
true if area labels are to be displayed; false otherwise.
 o setAreaLabels
 public void setAreaLabels(boolean areaLabels)
Sets area label visibility.

Parameters:
areaLabels - true if area labels are to be displayed; false otherwise.
 o showSwitchLinks
 public boolean showSwitchLinks()
Returns switch link visibility.

Returns:
true if switch-switch links are to be displayed; false otherwise.
 o setSwitchLinks
 public void setSwitchLinks(boolean switchLinks)
Sets switch link visibility.

Parameters:
switchLinks - true if switch-switch links are to be displayed; false otherwise.
 o showVCCs
 public boolean showVCCs()
Returns VCC visibility.

Returns:
true if VCCs are to be displayed; false otherwise.
 o setVCCs
 public void setVCCs(boolean VCCs)
Sets VCC visibility.

Parameters:
VCCs - true if VCCs are to be displayed; false otherwise.
 o showVCCSigType
 public boolean showVCCSigType(int type)
Returns VCC visibility by signalling type.

Parameters:
type - the signalling protocol whose visibility is being tested.
Returns:
true if VCCs established by the indicated signalling protocol are to be displayed; false if they are not.
 o setVCCSigType
 public void setVCCSigType(int type,
                           boolean b)
Sets VCC visibility by signalling type.

Parameters:
type - the signalling type whose visibility is to be set.
b - true if VCCs established by the indicated signalling protocol are to be displayed; false if they are not.
 o getVCCSigTypes
 public boolean[] getVCCSigTypes()
Gets the array of VCC visibility settings.

Returns:
a boolean array containing visibility settings for all signalling protocols.
 o getVCCSigColor
 public Color getVCCSigColor(int type)
Gets the VCC color by signalling type.

Parameters:
type - the signalling type whose color is desired.
Returns:
the display color for the signalling type.
 o getVCCSigColors
 public Color[] getVCCSigColors()
Gets the array of VCC signalling protocol colors.

Returns:
an array of colors for all signalling protocols.
 o showVCCOwner
 public boolean showVCCOwner(int owner)
Returns VCC visibility by owner.

Parameters:
owner - the owner whose visibility is being tested.
Returns:
true if VCCs established by the indicated owner are to be displayed; false if they are not.
 o setVCCOwner
 public void setVCCOwner(int owner,
                         boolean b)
Sets VCC visibility by owner.

Parameters:
owner - the owner whose visibility is being tested.
b - true if VCCs established by the indicated owner are to be displayed; false if they are not.
 o getVCCOwner
 public boolean[] getVCCOwner()
Gets the array of VCC owner settings.

Returns:
a boolean array containing visibility settings for all owners.
 o getVCCOwnerColor
 public Color getVCCOwnerColor(int owner)
Gets VCC color by owner.

Parameters:
owner - the owner whose color is desired.
Returns:
the display color for the owner.
 o getVCCOwnerColors
 public Color[] getVCCOwnerColors()
Gets the array of VCC owner colors.

Returns:
an array of colors for all owners.
 o getColorVCCBy
 public int getColorVCCBy()
Gets the method for choosing VCC colors.

Returns:
the method to be used to choose colors for VCCs.
 o setColorVCCBy
 public void setColorVCCBy(int method)
Sets the method for choosing VCC colors.

Parameters:
method - the method to be used to choose colors for VCCs.
 o getDrawVCCAs
 public int getDrawVCCAs()
Gets the method for drawing VCCs.

Returns:
the method to be used to draw VCCs.
 o setDrawVCCAs
 public void setDrawVCCAs(int method)
Sets the method for drawing VCCs.

Parameters:
return - method the method to be used to draw VCCs.
 o toString
 public String toString()
Gets a string describing the view settings.

Returns:
a String describing the view settings object.
Overrides:
toString in class Object