Package com.nomagic.reportwizard.tools

Class DialogTool

java.lang.Object

java.util.Observable

com.nomagic.magicreport.engine.Tool

com.nomagic.reportwizard.tools.DialogTool

All Implemented Interfaces:

ITool, IVariable, Serializable, Cloneable

@OpenApiAll
public class DialogTool
extends Tool

Class to create dialogs for interacts with user during report generation.

Since:

Jun 8, 2009

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.nomagic.magicreport.engine.ITool

ITool.HTMLString, ITool.RetainedString, ITool.Void

Field Summary

Fields inherited from class com.nomagic.magicreport.engine.Tool

context, properties

Fields inherited from interface com.nomagic.magicreport.engine.ITool

VOID

Constructor Summary

Constructors

Constructor	Description
DialogTool()

Method Summary

Modifier and Type	Method	Description
boolean	confirm(Object message)	Method for creating confirm dialog.
boolean	confirm(Object message, String title)	Method for creating confirm dialog with specific message and title.
String	getInputTitle()	Return default title of input dialog
String	input(Object message)	Method for creating input dialog with message.
String	input(Object message, Object initialValue)	Method for creating input dialog with message and initial value of input field.
String	input(Object message, Object initialValue, String title)	Method for creating input dialog with message, initial value of input field, and title.
String	input(Object message, Object initialValue, String title, String emptyText)	Method for creating input dialog with message, collection, title, and default value for empty text.
ITool.Void	message(Object message)	Method for creating Message dialog.
ITool.Void	message(Object message, String title)	Method for creating Message dialog with specific message and title.
Collection<Object>	select(Collection<Object> list)	Method for creating selection dialog with collection.
Collection<Object>	select(Collection<Object> list, String title)	Method for creating selection dialog with collection and title.
Collection<Object>	select(Collection<Object> list, String title, boolean defaultSelected)	Method for creating selection dialog with collection, title and default selection.
Collection<Object>	select(Collection<Object> list, String title, boolean defaultSelected, String message)	Method for creating selection dialog with collection, title, default selection, and user message.
Collection<Object>	select(Collection<Object> list, String title, boolean defaultSelected, String message, boolean showElementIcon)	Method for creating selection dialog with collection, title, default selection, and user message.
Collection<Object>	sort(String message, Collection<Object> list)	Method for creating sort dialog with collection and user message.
Collection<Object>	sort(String message, Collection<Object> list, boolean defaultEnabled)	Method for creating sort dialog with collection, user message, title, and initial value.
Collection<Object>	sort(String message, Collection<Object> list, String title, boolean defaultEnabled)	Method for creating sort dialog with collection and user message.
Collection<Object>	sort(String message, Collection<Object> list, String title, boolean defaultEnabled, boolean showElementIcon)	Method for creating sort dialog with collection and user message.
Collection<Object>	sort(Collection<Object> list)	Method for creating sort dialog with collection.
Collection<Object>	sort(Collection<Object> list, boolean defaultEnabled)	Method for creating sort dialog with collection and initial value.
Collection<Object>	sort(Collection<Object> list, String title)	Method for creating sort dialog with collection and title.
Collection<Object>	sort(Collection<Object> list, String title, boolean defaultEnabled)	Method for creating sort dialog with collection.

Methods inherited from class com.nomagic.magicreport.engine.Tool

clone, getContext, getProperties, getProperty, getProperty, notifyObservers, setContext, setProperties

Methods inherited from class java.util.Observable

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, setChanged

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.nomagic.magicreport.engine.ITool

clearTool

Constructor Details

DialogTool

public DialogTool()

Method Details

message

public ITool.Void message(Object message)

Method for creating Message dialog.

Parameters:

message - message for show in dialog.

Returns:

void not null value

message

public ITool.Void message(Object message,
 String title)

Method for creating Message dialog with specific message and title.

Parameters:

message - message for show in dialog.

title - dialog title

Returns:

void not null value

confirm

public boolean confirm(Object message)

Method for creating confirm dialog.

Parameters:

message - message for show in dialog.

Returns:

boolean value true when press OK button or false when press Cancel button.

confirm

public boolean confirm(Object message,
 String title)

Method for creating confirm dialog with specific message and title.

Parameters:

message - message for show in dialog.

title - dialog title

Returns:

boolean value true when press OK button or false when press Cancel button.

input

public String input(Object message)

Method for creating input dialog with message.

Parameters:

message - message for show in dialog.

Returns:

input value as string.

input

public String input(Object message,
 Object initialValue)

Method for creating input dialog with message and initial value of input field.

Parameters:

message - message for show in dialog.

initialValue - initial value of input field.

Returns:

input value as string.

input

public String input(Object message,
 Object initialValue,
 String title)

Method for creating input dialog with message, initial value of input field, and title.

Parameters:

message - message for show in dialog.

initialValue - initial value of input field.

title - dialog title

Returns:

input value as string.

input

public String input(Object message,
 Object initialValue,
 String title,
 String emptyText)

Method for creating input dialog with message, collection, title, and default value for empty text.

Parameters:

message - message for show in dialog.

initialValue - initial value of input field.

title - dialog title

emptyText - text to be shown when input is empty

Returns:

input value as string.

getInputTitle

public String getInputTitle()

Return default title of input dialog

Returns:

default title

sort

public Collection<Object> sort(Collection<Object> list)

Method for creating sort dialog with collection.

Parameters:

list - list collection for sort

Returns:

new sort collection

sort

public Collection<Object> sort(String message,
 Collection<Object> list)

Method for creating sort dialog with collection and user message.

Parameters:

message - message for show in dialog.

list - list collection for sort

Returns:

new sort collection

sort

public Collection<Object> sort(Collection<Object> list,
 String title)

Method for creating sort dialog with collection and title.

Parameters:

list - list collection for sort

title - dialog title

Returns:

new sort collection

sort

public Collection<Object> sort(Collection<Object> list,
 boolean defaultEnabled)

Method for creating sort dialog with collection and initial value.

Parameters:

list - list collection for sort

defaultEnabled - true to enable all items in collection by default.

Returns:

new sort collection

sort

public Collection<Object> sort(String message,
 Collection<Object> list,
 boolean defaultEnabled)

Method for creating sort dialog with collection, user message, title, and initial value.

Parameters:

message - message for show in dialog.

list - list collection for sort

defaultEnabled - true to enable all items in collection by default.

Returns:

new sort collection

sort

public Collection<Object> sort(Collection<Object> list,
 String title,
 boolean defaultEnabled)

Method for creating sort dialog with collection.

Parameters:

list - list collection for sort

title - dialog title

defaultEnabled - true to enabled all items in collection by default.

Returns:

new sort collection

sort

public Collection<Object> sort(String message,
 Collection<Object> list,
 String title,
 boolean defaultEnabled)

Method for creating sort dialog with collection and user message.

Parameters:

message - message for show in dialog.

list - list collection for sort

title - dialog title

defaultEnabled - true to enabled all items in collection by default.

Returns:

new sort collection

sort

public Collection<Object> sort(String message,
 Collection<Object> list,
 String title,
 boolean defaultEnabled,
 boolean showElementIcon)

Method for creating sort dialog with collection and user message.

Parameters:

message - message for show in dialog.

list - list collection for sort

title - dialog title

defaultEnabled - true to enabled all items in collection by default.

showElementIcon - true to show element icon for each element in the dialog

Returns:

new sort collection

select

public Collection<Object> select(Collection<Object> list)

Method for creating selection dialog with collection.

Parameters:

list - list collection for sort

Returns:

new collection with selected items

select

public Collection<Object> select(Collection<Object> list,
 String title)

Method for creating selection dialog with collection and title.

Parameters:

list - list collection for sort

title - dialog title

Returns:

new collection with selected items

select

public Collection<Object> select(Collection<Object> list,
 String title,
 boolean defaultSelected)

Method for creating selection dialog with collection, title and default selection.

Parameters:

list - list collection for sort

title - dialog title

defaultSelected - true to select all items in collection by default.

Returns:

new collection with selected items

select

public Collection<Object> select(Collection<Object> list,
 String title,
 boolean defaultSelected,
 String message)

Method for creating selection dialog with collection, title, default selection, and user message.

Parameters:

list - list collection for sort

title - dialog title

defaultSelected - true to select all items in collection by default.

message - message for show in dialog.

Returns:

new collection with selected items

select

public Collection<Object> select(Collection<Object> list,
 String title,
 boolean defaultSelected,
 String message,
 boolean showElementIcon)

Method for creating selection dialog with collection, title, default selection, and user message.

Parameters:

list - list collection for sort

title - dialog title

defaultSelected - true to select all items in collection by default.

message - message for show in dialog.

showElementIcon - true to show element icon for each element in the dialog

Returns:

new collection with selected items