sos.reports
Class DefaultReportEditorKit

java.lang.Object
  |
  +--sos.reports.DefaultReportEditorKit
All Implemented Interfaces:
ReportEditorKit, java.io.Serializable

public class DefaultReportEditorKit
extends java.lang.Object
implements ReportEditorKit, java.io.Serializable

A report editor kit that provides basic functionality.

Since:
1.0
See Also:
ReportEditorKit

Nested Class Summary
protected static class DefaultReportEditorKit.DefaultViewFactory
          A default view factory that creates views of instances of TableElement and ObjectElement.
static class DefaultReportEditorKit.ErrorFeedbackAction
          An action that provides error feedback, such as a beep.
static class DefaultReportEditorKit.ReportEditorKitAction
          A report action that provides convenience methods for providing error feedback, selecting elements, and scrolling.
 
Field Summary
 
Fields inherited from interface sos.reports.ReportEditorKit
ADVANCE_BACKWARD_ACTION_NAME, ADVANCE_FORWARD_ACTION_NAME, BACKWARD_ACTION_NAME, BEGIN_ACTION_NAME, BEGIN_EDIT_ACTION_NAME, BEGIN_REPORT_ACTION_NAME, BOLD_ACTION_NAME, CANCEL_EDIT_ACTION_NAME, CLEAR_ACTION_NAME, CLEAR_SEARCH_ACTION_NAME, COMMIT_EDIT_ACTION_NAME, COPY_ACTION_NAME, CUT_ACTION_NAME, DOWN_ACTION_NAME, END_ACTION_NAME, END_REPORT_ACTION_NAME, ERROR_FEEDBACK_ACTION_NAME, FIND_BACKWARD_ACTION_NAME, FIND_FORWARD_ACTION_NAME, FORWARD_ACTION_NAME, ITALIC_ACTION_NAME, JUMP_BACKWARD_ACTION_NAME, JUMP_DOWN_ACTION_NAME, JUMP_FORWARD_ACTION_NAME, JUMP_UP_ACTION_NAME, NARROW_ACTION_NAME, PASTE_ACTION_NAME, READ_ONLY_ACTION_NAME, SCROLL_DOWN_ACTION_NAME, SCROLL_UP_ACTION_NAME, SELECT_ALL_ACTION_NAME, SELECTION_BACKWARD_ACTION_NAME, SELECTION_BEGIN_ACTION_NAME, SELECTION_DOWN_ACTION_NAME, SELECTION_END_ACTION_NAME, SELECTION_FORWARD_ACTION_NAME, SELECTION_SCROLL_DOWN_ACTION_NAME, SELECTION_SCROLL_UP_ACTION_NAME, SELECTION_UP_ACTION_NAME, STRIKE_THROUGH_ACTION_NAME, UNDERLINE_ACTION_NAME, UNSELECT_ACTION_NAME, UP_ACTION_NAME, WIDEN_ACTION_NAME, WRITABLE_ACTION_NAME
 
Constructor Summary
DefaultReportEditorKit()
          Creates an instance of DefaultReportEditorKit.
 
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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DefaultReportEditorKit

public DefaultReportEditorKit()
Creates an instance of DefaultReportEditorKit.

Method Detail

getViewFactory

public ViewFactory getViewFactory()
Description copied from interface: ReportEditorKit
Returns the factory that creates the views that render the elements.

Specified by:
getViewFactory in interface ReportEditorKit
Returns:
the factory that creates the views that render the elements

getMouseOverComponent

public java.awt.Component getMouseOverComponent(View view)
Description copied from interface: ReportEditorKit
Returns the component that should be installed when the mouse is over the specified view.

Specified by:
getMouseOverComponent in interface ReportEditorKit
Parameters:
view - the element view for which the returned component applies
Returns:
the component that should be installed when the mouse is over view

install

public void install(JReportPane reportPane)
Description copied from interface: ReportEditorKit
Installs this editor kit into the specified report pane.

Specified by:
install in interface ReportEditorKit
Parameters:
reportPane - report pane into which this editor kit is being installed
See Also:
JReportPane.setEditorKit(sos.reports.ReportEditorKit), ReportEditorKit.uninstall(sos.reports.JReportPane)

uninstall

public void uninstall(JReportPane reportPane)
Description copied from interface: ReportEditorKit
Uninstalls this editor kit from the specified report pane.

Specified by:
uninstall in interface ReportEditorKit
Parameters:
reportPane - report pane that is no longer using this editor kit
See Also:
JReportPane.setEditorKit(sos.reports.ReportEditorKit), ReportEditorKit.install(sos.reports.JReportPane)

getActions

public javax.swing.Action[] getActions()
Description copied from interface: ReportEditorKit
Returns the actions that can be used by a report pane to edit a report.

Specified by:
getActions in interface ReportEditorKit
Returns:
the actions that can be used by a report pane to edit a report


Copyright 2003, 2004 Side of Software (SOS). All rights reserved.