shared
Class DisplayPref

java.lang.Object
  |
  +--shared.DisplayPref

Direct Known Subclasses:

ASCIIPref, DotGraphPref

public class DisplayPref

extends java.lang.Object

The DisplayPref class contains information on displaying options for MLJ inducers. There are seven possible preference settings(ASCIIDisplay, DotPostscriptDisplay, DotGraphDisplay, TreeVizDisplay, EviVizDisplay, RuleVizDisplay, and TableVizDisplay).

Field Summary

static int	ASCIIDisplay The value indicating the ASCIIDisplay preference setting.
static ASCIIPref	defaultDisplayPref The default display preferences.
static int	DisplayLandscape The value indicating the DisplayLandscape orientation setting.
static int	DisplayPortrait The value indicating the DisplayPortrait orientation setting.
static int	DotGraphDisplay The value indicating the DotGraphDisplay preference setting.
static int	DotPostscriptDisplay The value indicating the DotPostscriptDisplay preference setting.
static int	EviVizDisplay The value indicating the EviVizDisplay preference setting.
static int	RatioDefault The value indicating the RatioDefault ratio setting.
static int	RatioFill The value indicating the RatioFill ratio setting.
static int	RuleVizDisplay The value indicating the RuleVizDisplay preference setting.
static int	TableVizDisplay The value indicating the TableVizDisplay preference setting.
static int	TreeVizDisplay The value indicating the TreeVizDisplay preference setting.

Constructor Summary

DisplayPref(int preference)
Constructor.

Method Summary

boolean	get_display_backfit_disks() Returns whether the TreeVizPref setting is set to display bacfitting.
int	get_graph_size_x() Returns the x coordinate for the graph size for the DotPostscriptPref setting.
int	get_graph_size_y() Returns the y coordinate for the graph size for the DotPostscriptPref setting.
int	get_orientation() Returns the orientation for the DotPostscriptPref setting.
int	get_page_size_x() Returns the x coordinate for the page size for the DotPostscriptPref setting.
int	get_page_size_y() Returns the y coordinate for the page size for the DotPostscriptPref setting.
int	get_ratio() Returns the ratio for the DotPostscriptPref setting.
int	preference_type() Returns the preference type.
void	set_display_backfit_disks(boolean disp) Sets the TreeVizPref setting to display backfitting.
void	set_graph_size(int newX, int newY) Sets the graph size for the DotPostscriptPref setting.
void	set_orientation(int newOrientation) Sets the orientation for the DotPostscriptPref setting.
void	set_page_size(int newX, int newY) Sets the page size for the DotPostscriptPref setting.
void	set_preference_type(int newpref) Sets a new preference type.
void	set_ratio(int newRatio) Sets the ratio for the DotPostscriptPref setting.
java.lang.String	toString() Converts this object to a string value.

Methods inherited from class java.lang.Object

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

Field Detail

ASCIIDisplay

public static final int ASCIIDisplay

The value indicating the ASCIIDisplay preference setting.

DotPostscriptDisplay

public static final int DotPostscriptDisplay

The value indicating the DotPostscriptDisplay preference setting.

DotGraphDisplay

public static final int DotGraphDisplay

The value indicating the DotGraphDisplay preference setting.

TreeVizDisplay

public static final int TreeVizDisplay

The value indicating the TreeVizDisplay preference setting.

EviVizDisplay

public static final int EviVizDisplay

The value indicating the EviVizDisplay preference setting.

RuleVizDisplay

public static final int RuleVizDisplay

The value indicating the RuleVizDisplay preference setting.

TableVizDisplay

public static final int TableVizDisplay

The value indicating the TableVizDisplay preference setting.

DisplayLandscape

public static final int DisplayLandscape

The value indicating the DisplayLandscape orientation setting.

DisplayPortrait

public static final int DisplayPortrait

The value indicating the DisplayPortrait orientation setting.

RatioFill

public static final int RatioFill

The value indicating the RatioFill ratio setting.

RatioDefault

public static final int RatioDefault

The value indicating the RatioDefault ratio setting.

defaultDisplayPref

public static ASCIIPref defaultDisplayPref

The default display preferences.

Constructor Detail

DisplayPref

public DisplayPref(int preference)

Constructor.

Parameters:

preference - The display preference type. Takes only integers 0-6 where each integer represents an enumerated preference type (ASCIIDisplay,etc).

Method Detail

preference_type

public int preference_type()

Returns the preference type.

Returns:

The preference type.

set_preference_type

public void set_preference_type(int newpref)

Sets a new preference type.

Parameters:

newpref - The new preference type.

toString

public java.lang.String toString()

Converts this object to a string value.

Overrides:

toString in class java.lang.Object

Returns:

A string value representing this object.

get_page_size_x

public int get_page_size_x()

Returns the x coordinate for the page size for the DotPostscriptPref setting.

Returns:

The x coordinate for the page size for the DotPostscriptPref setting.

get_page_size_y

public int get_page_size_y()

Returns the y coordinate for the page size for the DotPostscriptPref setting.

Returns:

The y coordinate for the page size for the DotPostscriptPref setting.

get_graph_size_x

public int get_graph_size_x()

Returns the x coordinate for the graph size for the DotPostscriptPref setting.

Returns:

The x coordinate for the graph size for the DotPostscriptPref setting.

get_graph_size_y

public int get_graph_size_y()

Returns the y coordinate for the graph size for the DotPostscriptPref setting.

Returns:

The y coordinate for the graph size for the DotPostscriptPref setting.

get_orientation

public int get_orientation()

Returns the orientation for the DotPostscriptPref setting.

Returns:

The orientation for the DotPostscriptPref setting.

get_ratio

public int get_ratio()

Returns the ratio for the DotPostscriptPref setting.

Returns:

The ratio for the DotPostscriptPref setting.

set_page_size

public void set_page_size(int newX,
                          int newY)

Sets the page size for the DotPostscriptPref setting.

Parameters:

newX - The new x coordinate value for the page size.

newY - The new y coordinate value for the page size.

set_graph_size

public void set_graph_size(int newX,
                           int newY)

Sets the graph size for the DotPostscriptPref setting.

Parameters:

newX - The new x coordinate value for the page size.

newY - The new y coordinate value for the page size.

set_orientation

public void set_orientation(int newOrientation)

Sets the orientation for the DotPostscriptPref setting.

Parameters:

newOrientation - The new orientation setting.

set_ratio

public void set_ratio(int newRatio)

Sets the ratio for the DotPostscriptPref setting.

Parameters:

newRatio - The new ratio setting.

get_display_backfit_disks

public boolean get_display_backfit_disks()

Returns whether the TreeVizPref setting is set to display bacfitting.

Returns:

TRUE if the TreeVizPref setting is set to display backfitting, or FALSE otherwise.

set_display_backfit_disks

public void set_display_backfit_disks(boolean disp)

Sets the TreeVizPref setting to display backfitting.

Parameters:

disp - TRUE if displaying backfitting is requested, FALSE otherwise.