cytoscape.task.ui
Class JTaskConfig

java.lang.Object
  cytoscape.task.ui.JTaskConfig

public class JTaskConfig
extends Object

Used to configure the JTask UI component.

Constructor Summary

JTaskConfig()

Method Summary

void	displayCancelButton(boolean flag) Enables/Disables Display of the Cancel Button.
void	displayCloseButton(boolean flag) Enables/Disables Display of the Close Button.
void	displayStatus(boolean flag) Enables/Disables Display of the Status Field.
void	displayTimeElapsed(boolean flag) Enables/Disables Display of the Time Elapsed Field.
void	displayTimeRemaining(boolean flag) Enables/Disables Display of the Time Remaining Field.
int	getMillisToPopup() Gets Millieconds until JTask Dialog Box is Displayed.
void	setAutoDispose(boolean flag) Enables/Disables Auto-Dispose Feature.
void	setMillisToPopup(int millisToPopup) Sets Milliseconds until JTask Dialog Box is Displayed.
void	setModal(boolean modal) Enables modality of the JTask Dialog box.
void	setOwner(Container owner) Specifies the Owner of the JTask.

Methods inherited from class java.lang.Object

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

Constructor Detail

JTaskConfig

public JTaskConfig()

Method Detail

displayStatus

public void displayStatus(boolean flag)

Enables/Disables Display of the Status Field.

By default, this value is set to false.

Parameters:

flag - boolean value.

displayTimeElapsed

public void displayTimeElapsed(boolean flag)

Enables/Disables Display of the Time Elapsed Field.

By default, this value is set to false.

Parameters:

flag - boolean value.

displayTimeRemaining

public void displayTimeRemaining(boolean flag)

Enables/Disables Display of the Time Remaining Field.

By default, this value is set to false.

Parameters:

flag - boolean value.

displayCancelButton

public void displayCancelButton(boolean flag)

Enables/Disables Display of the Cancel Button.

By default, this value is set to false.

Parameters:

flag - boolean value.

displayCloseButton

public void displayCloseButton(boolean flag)

Enables/Disables Display of the Close Button.

By default, this value is set to false.

Parameters:

flag - boolean value.

setAutoDispose

public void setAutoDispose(boolean flag)

Enables/Disables Auto-Dispose Feature. When set to true, the JTask dialog box will automatically disappear when the task is complete. When set to false, the JTask dialog box will persist until the user dismissed it.

By default, this value is set to true.

Parameters:

flag - boolean value.

setOwner

public void setOwner(Container owner)

Specifies the Owner of the JTask.

Primarily used to center the JTask component relative to an owner, such as a JFrame object.

If set to null, the JTask component will be centered relative to the user's screen.

Parameters:

owner - Owner container. May be null.

setModal

public void setModal(boolean modal)

Enables modality of the JTask Dialog box.

When set to true, the JTask Dialog box is modal, and the user cannot interact with any other UI components on the screen.

When set to false, the JTask Dialog box is not modal, and the user may interact with other UI components on the screen.

By default, this value is set to true.

Parameters:

modal - modality flag.

setMillisToPopup

public void setMillisToPopup(int millisToPopup)

Sets Milliseconds until JTask Dialog Box is Displayed.

Default is set to 100 ms.

Parameters:

millisToPopup - long value.

getMillisToPopup

public int getMillisToPopup()

Gets Millieconds until JTask Dialog Box is Displayed.

Default is set to 100 ms.

Returns:

millisToPopup long value.