|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ICrystalReportsEditor
This interface defines an editor that can view or edit a Crystal report. This interface is not intended to be implemented by clients.
EditorUtilities
Field Summary | |
---|---|
static java.lang.String |
CR_EDITOR_ID
The identifier of the Crystal Reports editor. |
Method Summary | |
---|---|
void |
addClosedListener(IEditorClosedListener l)
Adds an listener that listens to when the editor is closed. |
void |
changeInput(IEditorInput newInput)
Sets the input for this editor to a new IEditorInput object. |
void |
close()
Closes the editor. |
ICrystalReportsEditorPage |
getActiveEditorPage()
Returns the page that is currently displayed in the Crystal Reports editor. |
IReportClientDocument |
getReportClientDocument()
Returns the active IReportClientDocument object. |
void |
removeClosedListener(IEditorClosedListener l)
Removes a listener that listens to when the editor is closed. |
void |
setActiveEditor(ICrystalReportsEditorPage editor)
Sets a page to be active. |
void |
setActiveEditor(java.lang.String editorId)
Sets a page to be active. |
Methods inherited from interface com.businessobjects.crystalreports.designer.sdk.ICrystalDocumentChangedService |
---|
addDocumentChangedListener, removeDocumentChangedListener |
Field Detail |
---|
static final java.lang.String CR_EDITOR_ID
plugin.xml
file.
Method Detail |
---|
IReportClientDocument getReportClientDocument()
IReportClientDocument
object.
If the editor is loading a report when this method is called,
this method will block until the report has been loaded.
This method must only be called from the Display
thread.
IReportClientDocument
objectvoid changeInput(IEditorInput newInput) throws java.lang.reflect.InvocationTargetException, java.lang.InterruptedException
IEditorInput
object.
If the newInput parameter represents a different IEditorInput
object, this method
fires a IEditorPart.PROP_INPUT
event.
If the IEditorInput
object does not represent a new
input, this method throws an exception and does not change the input.
newInput
- the new editor input
java.lang.InterruptedException
- if the input change is canceled or if a loading error has
occurred and has already been handled
java.lang.reflect.InvocationTargetException
- if the input change failedICrystalReportsEditorPage getActiveEditorPage()
void setActiveEditor(ICrystalReportsEditorPage editor)
editor
- the page to set activevoid setActiveEditor(java.lang.String editorId)
editorId
- the identifier of the page to set activevoid addClosedListener(IEditorClosedListener l)
l
- the listener to addvoid removeClosedListener(IEditorClosedListener l)
l
- listener to removevoid close()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |