sos.reports
Interface ReportEditorKit

All Known Implementing Classes:

DefaultReportEditorKit

public interface ReportEditorKit

An object that controls how a report is edited and manipulated.

A report editor should attempt to define actions for the names provided by this interface. These actions are returned by getActions. Actions that change the selection should feed all requests through JReportPane.changeSelection(sos.reports.Element, boolean, boolean).

Since:

1.0

See Also:

JReportPane

Field Summary

static java.lang.String	ADVANCE_BACKWARD_ACTION_NAME Name of the action that advances the selection to the previous element, wrapping if necessary.
static java.lang.String	ADVANCE_FORWARD_ACTION_NAME Name of the action that advances the selection to the next element, wrapping if necessary.
static java.lang.String	BACKWARD_ACTION_NAME Name of the action that moves the selection to the previous element.
static java.lang.String	BEGIN_ACTION_NAME Name of the action that moves the selection to the first element.
static java.lang.String	BEGIN_EDIT_ACTION_NAME Name of the action that starts editing the selection.
static java.lang.String	BEGIN_REPORT_ACTION_NAME Name of the action that moves the selection to the beginning of a report.
static java.lang.String	BOLD_ACTION_NAME Name of the action that toggles the bold attribute for the selection.
static java.lang.String	CANCEL_EDIT_ACTION_NAME Name of the action that stops the current editing, canceling any changes made.
static java.lang.String	CLEAR_ACTION_NAME Name of the action that clears the elements within the selection of a report.
static java.lang.String	CLEAR_SEARCH_ACTION_NAME Name of the action that resets the report search.
static java.lang.String	COMMIT_EDIT_ACTION_NAME Name of the action that stops the current editing, commiting any changes made.
static java.lang.String	COPY_ACTION_NAME Name of the action that copies the selection of a report to the clipboard.
static java.lang.String	CUT_ACTION_NAME Name of the action that clears the elements within the selection of a report but retains them in the clipboard.
static java.lang.String	DOWN_ACTION_NAME Name of the action that moves the selection down.
static java.lang.String	END_ACTION_NAME Name of the action that moves the selection to the last element.
static java.lang.String	END_REPORT_ACTION_NAME Name of the action that moves the selection to the end of a report.
static java.lang.String	ERROR_FEEDBACK_ACTION_NAME Name of the action that beeps or provides some other error feedback.
static java.lang.String	FIND_BACKWARD_ACTION_NAME Name of the action that identifies the previous search match.
static java.lang.String	FIND_FORWARD_ACTION_NAME Name of the action that identifies the next search match.
static java.lang.String	FORWARD_ACTION_NAME Name of the action that moves the selection to the next element.
static java.lang.String	ITALIC_ACTION_NAME Name of the action that toggles the italics attribute for the selection.
static java.lang.String	JUMP_BACKWARD_ACTION_NAME Name of the action that moves the selection backward to the next grouping.
static java.lang.String	JUMP_DOWN_ACTION_NAME Name of the action that moves the selection down to the next grouping.
static java.lang.String	JUMP_FORWARD_ACTION_NAME Name of the action that moves the selection forward to the next grouping.
static java.lang.String	JUMP_UP_ACTION_NAME Name of the action that moves the selection up to the next grouping.
static java.lang.String	NARROW_ACTION_NAME Name of the action that changes the selection to a child of the current selection.
static java.lang.String	PASTE_ACTION_NAME Name of the action that pastes from the clipboard to the report.
static java.lang.String	READ_ONLY_ACTION_NAME Name of the action that disables editing of a report.
static java.lang.String	SCROLL_DOWN_ACTION_NAME Name of the action that scrolls the report down one page.
static java.lang.String	SCROLL_UP_ACTION_NAME Name of the action that scrolls the report up one page.
static java.lang.String	SELECT_ALL_ACTION_NAME Name of the action that selects all elements in the current grouping.
static java.lang.String	SELECTION_BACKWARD_ACTION_NAME Name of the action that extends backward the selection of a report.
static java.lang.String	SELECTION_BEGIN_ACTION_NAME Name of the action that extends the selection to the beginning.
static java.lang.String	SELECTION_DOWN_ACTION_NAME Name of the action that extends the selection of a report down.
static java.lang.String	SELECTION_END_ACTION_NAME Name of the action that extends the selection to the end.
static java.lang.String	SELECTION_FORWARD_ACTION_NAME Name of the action that extends forward the selection of a report.
static java.lang.String	SELECTION_SCROLL_DOWN_ACTION_NAME Name of the action that extends forward the selection one page.
static java.lang.String	SELECTION_SCROLL_UP_ACTION_NAME Name of the action taht extends backward the selection one page.
static java.lang.String	SELECTION_UP_ACTION_NAME Name of the action that extends the selection of a report up.
static java.lang.String	STRIKE_THROUGH_ACTION_NAME Name of the action that toggles the strike-through attribute for the selection.
static java.lang.String	UNDERLINE_ACTION_NAME Name of the action that toggles the underline attribute for the selection.
static java.lang.String	UNSELECT_ACTION_NAME Name of the action that de-selects all elements of a report.
static java.lang.String	UP_ACTION_NAME Name of the action that moves the selection up.
static java.lang.String	WIDEN_ACTION_NAME Name of the action that changes the selection to a container of the current selection.
static java.lang.String	WRITABLE_ACTION_NAME Name of the action that enables editing of a report.

Method Summary

javax.swing.Action[]	getActions() Returns the actions that can be used by a report pane to edit a report.
java.awt.Component	getMouseOverComponent(View view) Returns the component that should be installed when the mouse is over the specified view.
ViewFactory	getViewFactory() Returns the factory that creates the views that render the elements.
void	install(JReportPane reportPane) Installs this editor kit into the specified report pane.
void	uninstall(JReportPane reportPane) Uninstalls this editor kit from the specified report pane.

Field Detail

ADVANCE_FORWARD_ACTION_NAME

public static final java.lang.String ADVANCE_FORWARD_ACTION_NAME

Name of the action that advances the selection to the next element, wrapping if necessary.

See Also:

Constant Field Values

ADVANCE_BACKWARD_ACTION_NAME

public static final java.lang.String ADVANCE_BACKWARD_ACTION_NAME

Name of the action that advances the selection to the previous element, wrapping if necessary.

See Also:

Constant Field Values

BACKWARD_ACTION_NAME

public static final java.lang.String BACKWARD_ACTION_NAME

Name of the action that moves the selection to the previous element.

See Also:

Constant Field Values

BEGIN_ACTION_NAME

public static final java.lang.String BEGIN_ACTION_NAME

Name of the action that moves the selection to the first element.

See Also:

Constant Field Values

BEGIN_EDIT_ACTION_NAME

public static final java.lang.String BEGIN_EDIT_ACTION_NAME

Name of the action that starts editing the selection.

See Also:

Constant Field Values

BEGIN_REPORT_ACTION_NAME

public static final java.lang.String BEGIN_REPORT_ACTION_NAME

Name of the action that moves the selection to the beginning of a report.

See Also:

Constant Field Values

BOLD_ACTION_NAME

public static final java.lang.String BOLD_ACTION_NAME

Name of the action that toggles the bold attribute for the selection.

See Also:

Constant Field Values

CANCEL_EDIT_ACTION_NAME

public static final java.lang.String CANCEL_EDIT_ACTION_NAME

Name of the action that stops the current editing, canceling any changes made.

See Also:

Constant Field Values

CLEAR_ACTION_NAME

public static final java.lang.String CLEAR_ACTION_NAME

Name of the action that clears the elements within the selection of a report.

See Also:

Constant Field Values

CLEAR_SEARCH_ACTION_NAME

public static final java.lang.String CLEAR_SEARCH_ACTION_NAME

Name of the action that resets the report search.

See Also:

Constant Field Values

COMMIT_EDIT_ACTION_NAME

public static final java.lang.String COMMIT_EDIT_ACTION_NAME

Name of the action that stops the current editing, commiting any changes made.

See Also:

Constant Field Values

COPY_ACTION_NAME

public static final java.lang.String COPY_ACTION_NAME

Name of the action that copies the selection of a report to the clipboard.

See Also:

Constant Field Values

CUT_ACTION_NAME

public static final java.lang.String CUT_ACTION_NAME

Name of the action that clears the elements within the selection of a report but retains them in the clipboard.

See Also:

Constant Field Values

DOWN_ACTION_NAME

public static final java.lang.String DOWN_ACTION_NAME

Name of the action that moves the selection down.

See Also:

Constant Field Values

END_ACTION_NAME

public static final java.lang.String END_ACTION_NAME

Name of the action that moves the selection to the last element.

See Also:

Constant Field Values

END_REPORT_ACTION_NAME

public static final java.lang.String END_REPORT_ACTION_NAME

Name of the action that moves the selection to the end of a report.

See Also:

Constant Field Values

ERROR_FEEDBACK_ACTION_NAME

public static final java.lang.String ERROR_FEEDBACK_ACTION_NAME

Name of the action that beeps or provides some other error feedback.

See Also:

Constant Field Values

FIND_BACKWARD_ACTION_NAME

public static final java.lang.String FIND_BACKWARD_ACTION_NAME

Name of the action that identifies the previous search match.

See Also:

Constant Field Values

FIND_FORWARD_ACTION_NAME

public static final java.lang.String FIND_FORWARD_ACTION_NAME

Name of the action that identifies the next search match.

See Also:

Constant Field Values

FORWARD_ACTION_NAME

public static final java.lang.String FORWARD_ACTION_NAME

Name of the action that moves the selection to the next element.

See Also:

Constant Field Values

ITALIC_ACTION_NAME

public static final java.lang.String ITALIC_ACTION_NAME

Name of the action that toggles the italics attribute for the selection.

See Also:

Constant Field Values

JUMP_BACKWARD_ACTION_NAME

public static final java.lang.String JUMP_BACKWARD_ACTION_NAME

Name of the action that moves the selection backward to the next grouping.

See Also:

Constant Field Values

JUMP_FORWARD_ACTION_NAME

public static final java.lang.String JUMP_FORWARD_ACTION_NAME

Name of the action that moves the selection forward to the next grouping.

See Also:

Constant Field Values

JUMP_DOWN_ACTION_NAME

public static final java.lang.String JUMP_DOWN_ACTION_NAME

Name of the action that moves the selection down to the next grouping.

See Also:

Constant Field Values

JUMP_UP_ACTION_NAME

public static final java.lang.String JUMP_UP_ACTION_NAME

Name of the action that moves the selection up to the next grouping.

See Also:

Constant Field Values

NARROW_ACTION_NAME

public static final java.lang.String NARROW_ACTION_NAME

Name of the action that changes the selection to a child of the current selection.

See Also:

Constant Field Values

PASTE_ACTION_NAME

public static final java.lang.String PASTE_ACTION_NAME

Name of the action that pastes from the clipboard to the report.

See Also:

Constant Field Values

READ_ONLY_ACTION_NAME

public static final java.lang.String READ_ONLY_ACTION_NAME

Name of the action that disables editing of a report.

See Also:

Constant Field Values

SCROLL_DOWN_ACTION_NAME

public static final java.lang.String SCROLL_DOWN_ACTION_NAME

Name of the action that scrolls the report down one page.

See Also:

Constant Field Values

SCROLL_UP_ACTION_NAME

public static final java.lang.String SCROLL_UP_ACTION_NAME

Name of the action that scrolls the report up one page.

See Also:

Constant Field Values

SELECT_ALL_ACTION_NAME

public static final java.lang.String SELECT_ALL_ACTION_NAME

Name of the action that selects all elements in the current grouping.

See Also:

Constant Field Values

SELECTION_BACKWARD_ACTION_NAME

public static final java.lang.String SELECTION_BACKWARD_ACTION_NAME

Name of the action that extends backward the selection of a report.

See Also:

Constant Field Values

SELECTION_BEGIN_ACTION_NAME

public static final java.lang.String SELECTION_BEGIN_ACTION_NAME

Name of the action that extends the selection to the beginning.

See Also:

Constant Field Values

SELECTION_DOWN_ACTION_NAME

public static final java.lang.String SELECTION_DOWN_ACTION_NAME

Name of the action that extends the selection of a report down.

See Also:

Constant Field Values

SELECTION_END_ACTION_NAME

public static final java.lang.String SELECTION_END_ACTION_NAME

Name of the action that extends the selection to the end.

See Also:

Constant Field Values

SELECTION_FORWARD_ACTION_NAME

public static final java.lang.String SELECTION_FORWARD_ACTION_NAME

Name of the action that extends forward the selection of a report.

See Also:

Constant Field Values

SELECTION_SCROLL_DOWN_ACTION_NAME

public static final java.lang.String SELECTION_SCROLL_DOWN_ACTION_NAME

Name of the action that extends forward the selection one page.

See Also:

Constant Field Values

SELECTION_SCROLL_UP_ACTION_NAME

public static final java.lang.String SELECTION_SCROLL_UP_ACTION_NAME

Name of the action taht extends backward the selection one page.

See Also:

Constant Field Values

SELECTION_UP_ACTION_NAME

public static final java.lang.String SELECTION_UP_ACTION_NAME

Name of the action that extends the selection of a report up.

See Also:

Constant Field Values

STRIKE_THROUGH_ACTION_NAME

public static final java.lang.String STRIKE_THROUGH_ACTION_NAME

Name of the action that toggles the strike-through attribute for the selection.

See Also:

Constant Field Values

UNDERLINE_ACTION_NAME

public static final java.lang.String UNDERLINE_ACTION_NAME

Name of the action that toggles the underline attribute for the selection.

See Also:

Constant Field Values

UNSELECT_ACTION_NAME

public static final java.lang.String UNSELECT_ACTION_NAME

Name of the action that de-selects all elements of a report.

See Also:

Constant Field Values

UP_ACTION_NAME

public static final java.lang.String UP_ACTION_NAME

Name of the action that moves the selection up.

See Also:

Constant Field Values

WIDEN_ACTION_NAME

public static final java.lang.String WIDEN_ACTION_NAME

Name of the action that changes the selection to a container of the current selection.

See Also:

Constant Field Values

WRITABLE_ACTION_NAME

public static final java.lang.String WRITABLE_ACTION_NAME

Name of the action that enables editing of a report.

See Also:

Constant Field Values

Method Detail

getActions

public javax.swing.Action[] getActions()

Returns the actions that can be used by a report pane to edit a report.

Returns:

the actions that can be used by a report pane to edit a report

getMouseOverComponent

public java.awt.Component getMouseOverComponent(View view)

Returns the component that should be installed when the mouse is over the specified view.

Parameters:

view - the element view for which the returned component applies

Returns:

the component that should be installed when the mouse is over view

getViewFactory

public ViewFactory getViewFactory()

Returns the factory that creates the views that render the elements.

Returns:

the factory that creates the views that render the elements

install

public void install(JReportPane reportPane)

Installs this editor kit into the specified report pane.

Parameters:

reportPane - report pane into which this editor kit is being installed

See Also:

JReportPane.setEditorKit(sos.reports.ReportEditorKit), uninstall(sos.reports.JReportPane)

uninstall

public void uninstall(JReportPane reportPane)

Uninstalls this editor kit from the specified report pane.

Parameters:

reportPane - report pane that is no longer using this editor kit

See Also:

JReportPane.setEditorKit(sos.reports.ReportEditorKit), install(sos.reports.JReportPane)