Package com.inet.designer
Class AbstractDesignerDataModel
java.lang.Object
com.inet.designer.AbstractDesignerDataModel
- All Implemented Interfaces:
DesignerDataModel
- Direct Known Subclasses:
BasicDesignerDataModel
The data model describes the way the i-net Designer creates, loads and stores its reports. The default
implementation is based on the file system, but you may want to store the reports in a database instead or maybe you
simply want to restrict the access to certain files.
-
Field Summary
Fields inherited from interface com.inet.designer.DesignerDataModel
TYPE_COMMAND, TYPE_CONNECTION, TYPE_SPROC, TYPE_SPROC_WITH_PARAM, TYPE_SYSTEM_TABLE, TYPE_TABLE, TYPE_VIEW, TYPE_VIEW_WITH_PARAM
-
Constructor Summary
ConstructorDescriptionInitializes this DesignerDataModel implementation. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addedElement
(Element element) This method is called if the user has added an element to the report.void
addedGroup
(Group group) This method is called if a group was added to the report by the user.void
addedSubreport
(Engine engine) This method is called if a subreport was added to the current report.void
closedReport
(Engine engine) This method is called if a report was closed.void
closedSubreport
(Engine engine) This method is called if a subreport was closed by the user.creates a newSwingReportViewer
and initializes it with the necessaryViewerContext
, as well as piping its log stream to the appropriate position (viaSwingReportViewer.setLoggingStream(java.io.PrintStream)
.Returns the location of the application directory which is the directory where the designer is located in.ArrayList<com.inet.font.FontFamily>
Returns a list of all available fonts for the designer.List<com.inet.font.FontFamily>
fetches a list of fonts available on the repository configured for the designerboolean
isAddElementAllowed
(int elementType) This method checks if its allowed to add a element to a report with the i-net Designer.boolean
This method checks if its allowed to add new groups to any report.boolean
This method checks if its allowed to add a new section to a report with the i-net Designer.boolean
This method checks if its allowed to close reports opened with the i-net Designer.boolean
Check if the database configuration may be changed.boolean
isDatabaseObjectVisible
(int databaseObjectType, String databaseObjectName) Checks if the given database object should be visible in the database browser.boolean
Returns whether the datasource manager dialog is accessible or not.boolean
This method checks if the with the i-net Designer opened reports need a database connection.boolean
Returns true if the templates supplied through i-net will be enabled or not.boolean
This method checks if a invalid connection is selectable in the virtual database dialog.boolean
Check if opening reports is allowed.boolean
Checks if the preview tab should be visible or not.boolean
isRemoveElementAllowed
(int elementType) This method checks if its allowed to remove a element from a report with the i-net Designer.boolean
This method checks if its allowed to remove a group from the report opened with the i-net Designer.boolean
This method checks if its allowed to remove section from a report with the i-net Designer.boolean
This method checks if its allowed to reopen a report with the i-net Designer.boolean
Returns true if a new report shall be created using the ReportWizard.boolean
Check if save is allowed.boolean
Check if save as is allowed.boolean
Check if tables may be added or removed and if the links may be changed.Engine[]
loadReportsFrom
(Component parent, URL initialURL) Loads one or more report.void
openedSubreport
(Engine engine) This method is called if a subreport was opened by the user to edit it.void
openFacturMappingDialog
(String searchterm) This method is called if the user wants to open the Fractur mapping dialog.void
Opens a dialog enabling the user to choose a report file to open from the repository configured for the designer.void
openGroupDialog
(Group group) This method is called if the user wants to open the dialog for a group.openGroupSelectionFormulaDialog
(FormulaField formulafield) This method is called if the user wants to open the dialog for a group selection formula.void
This method is called if the user wants to open the Java Bean dialog.void
This method is called if the user wants to open the Page Layout dialog.void
openParameterDialog
(PromptField parameterField) This method is called if the user wants to open the dialog for a parameter field.openPropertyFormulaDialog
(FormulaField formulafield, int valueType, ReportComponent element, Object defaultValue, String property, boolean isTristate) FOR INTERNAL USE ONLY This method is called if the user wants to open the dialog for a property formula.openRecordSelectionFormulaDialog
(FormulaField formulafield) This method is called if the user wants to open the dialog for a record selection formula.void
Opens a repository configuration dialog which enables the user to choose the repository URL he wants to employ when opening and saving reports on a repository.void
openSectionDialog
(Section section) This method is called if the user wants to open the Section dialog.void
This method is called if the user wants to open the Records dialog.openSQLDialog
(SQLField sqlField) This method is called if the user wants to open the dialog for a SQL field.void
openSubreportLinksDialog
(String reportName) This method is called if the user wants to open the Subreport links dialog.void
openSumDialog
(SummaryField sumfield) This method is called if the user wants to open the dialog for a summary field.void
This method is called if the user wants to open the Summary Info dialog.openUserFormulaDialog
(FormulaField formulafield) This method is called if the user wants to open the dialog for a user defined formula.void
This method is called if the user wants to open the Visual Database Wizard dialog.void
removedElement
(Element element) This method is called if the user has removed an element from the report.void
removedGroup
(Group group) This method is called if a group was removed from the report by the user.void
removedSubreport
(Engine engine) This method will be called if a subreport was removed from the current report.reopenReport
(File reportFile) Load a report.void
Opens up a save dialog which enables the user to save a report onto the repository configured for the designer.void
setAddElementAllowed
(boolean isAddElementAllowed, int elementType) Set if its allowed to add a element to a report with the i-net Designer.void
setAddGroupAllowed
(boolean isAddGroupAllowed) Set if its allowed to add new groups to the reports.void
setAddSectionAllowed
(boolean isAddSectionAllowed) Set if its allowed to add a new section to a report with the i-net Designer.void
setCloseAllowed
(boolean isCloseAllowed) Set if its allowed to close reports opened with the i-net Designer.void
setDatabaseChangeAllowed
(boolean databaseChangeAllowed) Set if changes to the connection are allowed.void
setDataSourceManagerAllowed
(boolean isAllowed) Sets whether the datasource manager dialog shall be accessible or not.void
setDesignNeedsConnection
(boolean designNeedsConnection) Set if the with the i-net Designer opened reports need a database connection.void
setIsInvalidSPSelectable
(boolean newSIISPS) Set if a invalid connection is selectable in the virtual database dialog.void
setOpenAllowed
(boolean openAllowed) Set if open is allowed.void
setPreviewTabVisible
(boolean previewTabVisible) Use this method to enable/disable the preview tab of the i-net Designer.void
setRemoveElementAllowed
(boolean isRemoveElementAllowed, int elementType) Set if its allowed to remove a element from a report with the i-net Designer.void
setRemoveGroupAllowed
(boolean isRemoveGroupAllowed) Set if its allowed to remove a group from the report opened with the i-net Designer.void
setRemoveSectionAllowed
(boolean isRemoveSectionAllowed) Set if its allowed to remove a section from a report with the i-net Designer.void
setReopenAllowed
(boolean isReopenAllowed) Set if its allowed to reopen a report with the i-net Designer.void
setSaveAllowed
(boolean saveAllowed) Set if save is allowed.void
setSaveAsAllowed
(boolean saveAsAllowed) Set if save as is allowed.void
setTablesChangeAllowed
(boolean tablesChangeAllowed) Set if tables may be changed.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.inet.designer.DesignerDataModel
createNewReport, loadReport, loadReportFrom, saveReport
-
Constructor Details
-
AbstractDesignerDataModel
public AbstractDesignerDataModel()Initializes this DesignerDataModel implementation.- Since:
- 6.0
-
-
Method Details
-
getApplicationDirectory
Returns the location of the application directory which is the directory where the designer is located in.- Specified by:
getApplicationDirectory
in interfaceDesignerDataModel
- Returns:
- The directory where the designer is located in.
- Since:
- 7.0
-
isReportWizardEnabled
public boolean isReportWizardEnabled()Returns true if a new report shall be created using the ReportWizard.- Specified by:
isReportWizardEnabled
in interfaceDesignerDataModel
- Returns:
- true <=> Create a new report using the ReportWizard.
- Since:
- 7.0
-
isInetTemplatesEnabled
public boolean isInetTemplatesEnabled()Returns true if the templates supplied through i-net will be enabled or not.- Specified by:
isInetTemplatesEnabled
in interfaceDesignerDataModel
- Returns:
- true <=> The templates supplied through i-net will be enabled.
- Since:
- 7.0
-
getAvailableFonts
Returns a list of all available fonts for the designer.- Specified by:
getAvailableFonts
in interfaceDesignerDataModel
- Returns:
- A list of all available fonts.
- Since:
- 9.1
-
getAvailableFontsFromRepository
fetches a list of fonts available on the repository configured for the designer- Specified by:
getAvailableFontsFromRepository
in interfaceDesignerDataModel
- Returns:
- list of fonts available on the repository configured for the designer
- Since:
- 9.2
-
isPreviewTabVisible
public boolean isPreviewTabVisible()Checks if the preview tab should be visible or not.- Specified by:
isPreviewTabVisible
in interfaceDesignerDataModel
- Returns:
true
if the preview tab should be visible otherwisefalse
-
setPreviewTabVisible
public void setPreviewTabVisible(boolean previewTabVisible) Use this method to enable/disable the preview tab of the i-net Designer.- Specified by:
setPreviewTabVisible
in interfaceDesignerDataModel
- Parameters:
previewTabVisible
-true
to allow,false
to deny- Since:
- 6.0
-
isDatabaseObjectVisible
Checks if the given database object should be visible in the database browser.- Specified by:
isDatabaseObjectVisible
in interfaceDesignerDataModel
- Parameters:
databaseObjectType
- The type of the database object. This will be one of the followingtable
,system table
,view
orstored procedure
databaseObjectName
- The name of the database object (e.g. of a table)- Returns:
- In the AbstractDesignerDataModel this will always return
true
- Since:
- 7.0
-
isDatabaseChangeAllowed
public boolean isDatabaseChangeAllowed()Check if the database configuration may be changed.- Specified by:
isDatabaseChangeAllowed
in interfaceDesignerDataModel
- Returns:
- true if it is allowed to change the database configuration.
- Since:
- 6.0
-
isOpenAllowed
public boolean isOpenAllowed()Check if opening reports is allowed.- Specified by:
isOpenAllowed
in interfaceDesignerDataModel
- Returns:
- true if it is allowed to open reports
- Since:
- 6.0
-
isSaveAllowed
public boolean isSaveAllowed()Check if save is allowed.- Specified by:
isSaveAllowed
in interfaceDesignerDataModel
- Returns:
- true if it is allowed to save reports
- Since:
- 6.0
-
isSaveAsAllowed
public boolean isSaveAsAllowed()Check if save as is allowed.- Specified by:
isSaveAsAllowed
in interfaceDesignerDataModel
- Returns:
- true if it is allowed to save reports with a new name (Save As)
- Since:
- 6.0
-
isTablesChangeAllowed
public boolean isTablesChangeAllowed()Check if tables may be added or removed and if the links may be changed.- Specified by:
isTablesChangeAllowed
in interfaceDesignerDataModel
- Returns:
- true if it is allowed to add or remove tables
- Since:
- 6.0
-
setDatabaseChangeAllowed
public void setDatabaseChangeAllowed(boolean databaseChangeAllowed) Set if changes to the connection are allowed.- Specified by:
setDatabaseChangeAllowed
in interfaceDesignerDataModel
- Parameters:
databaseChangeAllowed
-true
to allow,false
to deny- Since:
- 6.0
-
setOpenAllowed
public void setOpenAllowed(boolean openAllowed) Set if open is allowed.- Specified by:
setOpenAllowed
in interfaceDesignerDataModel
- Parameters:
openAllowed
-true
to allow,false
to deny- Since:
- 6.0
-
setSaveAllowed
public void setSaveAllowed(boolean saveAllowed) Set if save is allowed.- Specified by:
setSaveAllowed
in interfaceDesignerDataModel
- Parameters:
saveAllowed
-true
to allow,false
to deny- Since:
- 6.0
-
setSaveAsAllowed
public void setSaveAsAllowed(boolean saveAsAllowed) Set if save as is allowed.- Specified by:
setSaveAsAllowed
in interfaceDesignerDataModel
- Parameters:
saveAsAllowed
-true
to allow,false
to deny- Since:
- 6.0
-
setTablesChangeAllowed
public void setTablesChangeAllowed(boolean tablesChangeAllowed) Set if tables may be changed.- Specified by:
setTablesChangeAllowed
in interfaceDesignerDataModel
- Parameters:
tablesChangeAllowed
-true
to allow,false
to deny- Since:
- 6.0
-
isDesignNeedsConnection
public boolean isDesignNeedsConnection()This method checks if the with the i-net Designer opened reports need a database connection.- Specified by:
isDesignNeedsConnection
in interfaceDesignerDataModel
- Returns:
true
if the report needs a connection,false
if not.- Since:
- 6.0
-
setDesignNeedsConnection
public void setDesignNeedsConnection(boolean designNeedsConnection) Set if the with the i-net Designer opened reports need a database connection.- Specified by:
setDesignNeedsConnection
in interfaceDesignerDataModel
- Parameters:
designNeedsConnection
-true
if the report needs a connection,false
if not.- Since:
- 6.0
-
isInvalidSPSelectable
public boolean isInvalidSPSelectable()This method checks if a invalid connection is selectable in the virtual database dialog.- Specified by:
isInvalidSPSelectable
in interfaceDesignerDataModel
- Returns:
true
if invalid SPs are selectable,false
if not.- Since:
- 6.0
-
setIsInvalidSPSelectable
public void setIsInvalidSPSelectable(boolean newSIISPS) Set if a invalid connection is selectable in the virtual database dialog.- Parameters:
newSIISPS
-true
if invalid SPs are selectable,false
if not.- Since:
- 6.0
-
isAddGroupAllowed
public boolean isAddGroupAllowed()This method checks if its allowed to add new groups to any report.- Specified by:
isAddGroupAllowed
in interfaceDesignerDataModel
- Returns:
true
if its allowed to add new groups,false
if not.- Since:
- 6.0
-
setAddGroupAllowed
public void setAddGroupAllowed(boolean isAddGroupAllowed) Set if its allowed to add new groups to the reports.- Specified by:
setAddGroupAllowed
in interfaceDesignerDataModel
- Parameters:
isAddGroupAllowed
-true
if its allowed to add new groups,false
if not.- Since:
- 6.0
-
isCloseAllowed
public boolean isCloseAllowed()This method checks if its allowed to close reports opened with the i-net Designer.- Specified by:
isCloseAllowed
in interfaceDesignerDataModel
- Returns:
true
if its allowed to close the report,false
if not.- Since:
- 6.0
-
setCloseAllowed
public void setCloseAllowed(boolean isCloseAllowed) Set if its allowed to close reports opened with the i-net Designer.- Specified by:
setCloseAllowed
in interfaceDesignerDataModel
- Parameters:
isCloseAllowed
-true
if its allowed to close the report,false
if not.- Since:
- 6.0
-
isRemoveGroupAllowed
public boolean isRemoveGroupAllowed()This method checks if its allowed to remove a group from the report opened with the i-net Designer.- Specified by:
isRemoveGroupAllowed
in interfaceDesignerDataModel
- Returns:
true
if its allowed to remove groups,false
if not.- Since:
- 6.0
-
setRemoveGroupAllowed
public void setRemoveGroupAllowed(boolean isRemoveGroupAllowed) Set if its allowed to remove a group from the report opened with the i-net Designer.- Specified by:
setRemoveGroupAllowed
in interfaceDesignerDataModel
- Parameters:
isRemoveGroupAllowed
-true
if its allowed to remove groups,false
if not.- Since:
- 6.0
-
isReopenAllowed
public boolean isReopenAllowed()This method checks if its allowed to reopen a report with the i-net Designer.- Specified by:
isReopenAllowed
in interfaceDesignerDataModel
- Returns:
true
if its allowed to reopen a report,false
if not.- Since:
- 6.0
-
setReopenAllowed
public void setReopenAllowed(boolean isReopenAllowed) Set if its allowed to reopen a report with the i-net Designer.- Specified by:
setReopenAllowed
in interfaceDesignerDataModel
- Parameters:
isReopenAllowed
-true
if its allowed to reopen a report,false
if not.- Since:
- 6.0
-
setAddElementAllowed
public void setAddElementAllowed(boolean isAddElementAllowed, int elementType) Set if its allowed to add a element to a report with the i-net Designer.- Specified by:
setAddElementAllowed
in interfaceDesignerDataModel
- Parameters:
isAddElementAllowed
-true
if its allowed to add the element,false
if not.elementType
- Type of the element you want to allow/deny.- Since:
- 6.0
- See Also:
-
isAddElementAllowed
public boolean isAddElementAllowed(int elementType) This method checks if its allowed to add a element to a report with the i-net Designer.- Specified by:
isAddElementAllowed
in interfaceDesignerDataModel
- Parameters:
elementType
- Type of the element you want to allow/deny.- Returns:
- True if elements of the supplied type can be added to the report false otherwise.
- Since:
- 6.0
- See Also:
-
setRemoveElementAllowed
public void setRemoveElementAllowed(boolean isRemoveElementAllowed, int elementType) Set if its allowed to remove a element from a report with the i-net Designer.- Specified by:
setRemoveElementAllowed
in interfaceDesignerDataModel
- Parameters:
isRemoveElementAllowed
-true
if its allowed to remove the element,false
if not.elementType
- Type of the element you want to allow/deny.- Since:
- 6.0
- See Also:
-
isRemoveElementAllowed
public boolean isRemoveElementAllowed(int elementType) This method checks if its allowed to remove a element from a report with the i-net Designer.- Specified by:
isRemoveElementAllowed
in interfaceDesignerDataModel
- Parameters:
elementType
- Type of the element you want to allow/deny.- Returns:
- True if elements of the supplied type can be removed from the report false otherwise.
- Since:
- 6.0
- See Also:
-
isAddSectionAllowed
public boolean isAddSectionAllowed()This method checks if its allowed to add a new section to a report with the i-net Designer.- Specified by:
isAddSectionAllowed
in interfaceDesignerDataModel
- Returns:
true
if its allowed to add a section to a report,false
if not.- Since:
- 6.0
-
setAddSectionAllowed
public void setAddSectionAllowed(boolean isAddSectionAllowed) Set if its allowed to add a new section to a report with the i-net Designer.- Specified by:
setAddSectionAllowed
in interfaceDesignerDataModel
- Parameters:
isAddSectionAllowed
-true
if its allowed to add a section to a report,false
if not.- Since:
- 6.0
-
isRemoveSectionAllowed
public boolean isRemoveSectionAllowed()This method checks if its allowed to remove section from a report with the i-net Designer.- Specified by:
isRemoveSectionAllowed
in interfaceDesignerDataModel
- Returns:
true
if its allowed to remove a section from a report,false
if not.- Since:
- 6.0
-
setRemoveSectionAllowed
public void setRemoveSectionAllowed(boolean isRemoveSectionAllowed) Set if its allowed to remove a section from a report with the i-net Designer.- Specified by:
setRemoveSectionAllowed
in interfaceDesignerDataModel
- Parameters:
isRemoveSectionAllowed
-true
if its allowed to remove a section from a report,false
if not.- Since:
- 6.0
-
openParameterDialog
This method is called if the user wants to open the dialog for a parameter field. The dialog is responsible to create an undo point in case of a modification. This function may be called only if an editor has been opened.- Specified by:
openParameterDialog
in interfaceDesignerDataModel
- Parameters:
parameterField
- The parameter field if already existent, otherwise null Note: Since version 7.0 this method does not return the modified field anymore.
-
openSQLDialog
This method is called if the user wants to open the dialog for a SQL field. The dialog is responsible to create an undo point in case of a modification.- Specified by:
openSQLDialog
in interfaceDesignerDataModel
- Parameters:
sqlField
- The SQL field if already existent, otherwise null- Returns:
- The new SQL field or null if no field was created
-
openSumDialog
This method is called if the user wants to open the dialog for a summary field. The dialog is responsible to create an undo point in case of a modification. This function may only be called if an editor has been opened.- Specified by:
openSumDialog
in interfaceDesignerDataModel
- Parameters:
sumfield
- The parameter field if already existent, otherwise null
-
openGroupDialog
This method is called if the user wants to open the dialog for a group. The dialog is responsible to create an undo point in case of a modification.- Specified by:
openGroupDialog
in interfaceDesignerDataModel
- Parameters:
group
- The group if already existent, otherwise null
-
openSummaryInfoDialog
public void openSummaryInfoDialog()This method is called if the user wants to open the Summary Info dialog. The dialog is responsible to create an undo point in case of a modification.- Specified by:
openSummaryInfoDialog
in interfaceDesignerDataModel
-
openSortRecordsDialog
public void openSortRecordsDialog()This method is called if the user wants to open the Records dialog. The dialog is responsible to create an undo point in case of a modification.- Specified by:
openSortRecordsDialog
in interfaceDesignerDataModel
-
openSubreportLinksDialog
This method is called if the user wants to open the Subreport links dialog. The dialog is responsible to create an undo point in case of a modification.- Specified by:
openSubreportLinksDialog
in interfaceDesignerDataModel
- Parameters:
reportName
- Name of the subreport or null if no subreport was selected
-
openSectionDialog
This method is called if the user wants to open the Section dialog. The dialog is responsible to create an undo point in case of a modification.- Specified by:
openSectionDialog
in interfaceDesignerDataModel
- Parameters:
section
- the selected section or null if no section was selected
-
openVisualDatabaseWizardDialog
public void openVisualDatabaseWizardDialog()This method is called if the user wants to open the Visual Database Wizard dialog. The dialog is responsible to create an undo point in case of a modification. Note: It is not allowed to call the super method of this dialog, because it will not show the correct database configuration.- Specified by:
openVisualDatabaseWizardDialog
in interfaceDesignerDataModel
-
openJavaBeanDialog
public void openJavaBeanDialog()This method is called if the user wants to open the Java Bean dialog. The dialog is responsible to create an undo point in case of a modification.- Specified by:
openJavaBeanDialog
in interfaceDesignerDataModel
-
openUserFormulaDialog
This method is called if the user wants to open the dialog for a user defined formula. The dialog is responsible to create an undo point in case of a modification. This function may be called only if an editor has been opened.- Specified by:
openUserFormulaDialog
in interfaceDesignerDataModel
- Parameters:
formulafield
- The formula field if already existent, otherwise null- Returns:
- The new formula field or null if no field was created
-
openPropertyFormulaDialog
public FormulaField openPropertyFormulaDialog(FormulaField formulafield, int valueType, ReportComponent element, Object defaultValue, String property, boolean isTristate) FOR INTERNAL USE ONLY This method is called if the user wants to open the dialog for a property formula. The dialog is responsible to create an undo point in case of a modification. This function may be called only if an editor has been opened.- Specified by:
openPropertyFormulaDialog
in interfaceDesignerDataModel
- Parameters:
formulafield
- TheFormulaField
if it already exists, otherwisenull
valueType
- The type of the formulas return valueelement
- The element thats formula this isdefaultValue
- The default value for this formulaproperty
- The name of the property for which a formula is being created. Must not benull
.isTristate
- whether the returned property formula is set to more than one Element. When in doubt, set tofalse
- Returns:
- The new formula field or null if no field was created
-
openRecordSelectionFormulaDialog
This method is called if the user wants to open the dialog for a record selection formula. The dialog is responsible to create an undo point in case of a modification. This function may be called only if an editor has been opened.- Specified by:
openRecordSelectionFormulaDialog
in interfaceDesignerDataModel
- Parameters:
formulafield
- The formulafield if it already exists, otherwise null- Returns:
- The new formula field or null if no field was created
-
openGroupSelectionFormulaDialog
This method is called if the user wants to open the dialog for a group selection formula. The dialog is responsible to create an undo point in case of a modification. This function may be called only if an editor has been opened.- Specified by:
openGroupSelectionFormulaDialog
in interfaceDesignerDataModel
- Parameters:
formulafield
- The formulafield if already existent, otherwise null- Returns:
- The new formula field or null if no field was created
-
closedReport
This method is called if a report was closed.- Specified by:
closedReport
in interfaceDesignerDataModel
- Parameters:
engine
- the engine of the closed report.
-
addedSubreport
This method is called if a subreport was added to the current report.- Specified by:
addedSubreport
in interfaceDesignerDataModel
- Parameters:
engine
- the engine of the added subreport.
-
removedSubreport
This method will be called if a subreport was removed from the current report.- Specified by:
removedSubreport
in interfaceDesignerDataModel
- Parameters:
engine
- the engine of the removed subreport.
-
openedSubreport
This method is called if a subreport was opened by the user to edit it. The dialog is responsible to create an undo point in case of a modification.- Specified by:
openedSubreport
in interfaceDesignerDataModel
- Parameters:
engine
- the engine of the opened subreport.
-
closedSubreport
This method is called if a subreport was closed by the user.- Specified by:
closedSubreport
in interfaceDesignerDataModel
- Parameters:
engine
- the engine of the closed subreport.
-
addedGroup
This method is called if a group was added to the report by the user.- Specified by:
addedGroup
in interfaceDesignerDataModel
- Parameters:
group
- the added group.
-
removedGroup
This method is called if a group was removed from the report by the user.- Specified by:
removedGroup
in interfaceDesignerDataModel
- Parameters:
group
- the removed group.
-
addedElement
This method is called if the user has added an element to the report.- Specified by:
addedElement
in interfaceDesignerDataModel
- Parameters:
element
- the added element.
-
removedElement
This method is called if the user has removed an element from the report.- Specified by:
removedElement
in interfaceDesignerDataModel
- Parameters:
element
- the removed element.
-
reopenReport
Load a report. If the location was chosen from the list of last opened reports, it is the programmer's task to load the report and return the engine.- Specified by:
reopenReport
in interfaceDesignerDataModel
- Parameters:
reportFile
- the file object which contains the path to the report.- Returns:
- the engine of the loaded report
- Throws:
ReportException
- to indicate nothing was loaded as the result of a Report problem
-
openPageLayoutDialog
public void openPageLayoutDialog()This method is called if the user wants to open the Page Layout dialog. The dialog is responsible to create an undo point in case of a modification.- Specified by:
openPageLayoutDialog
in interfaceDesignerDataModel
-
isDataSourceManagerAllowed
public boolean isDataSourceManagerAllowed()Returns whether the datasource manager dialog is accessible or not.- Specified by:
isDataSourceManagerAllowed
in interfaceDesignerDataModel
- Returns:
- True if the datasource manager dialog can be used false otherwise.
-
setDataSourceManagerAllowed
public void setDataSourceManagerAllowed(boolean isAllowed) Sets whether the datasource manager dialog shall be accessible or not.- Specified by:
setDataSourceManagerAllowed
in interfaceDesignerDataModel
- Parameters:
isAllowed
- True if the datasource manager dialog should be accessible false otherwise.
-
openRepositoryConfigDialog
public void openRepositoryConfigDialog()Opens a repository configuration dialog which enables the user to choose the repository URL he wants to employ when opening and saving reports on a repository.- Specified by:
openRepositoryConfigDialog
in interfaceDesignerDataModel
- See Also:
-
openFacturMappingDialog
This method is called if the user wants to open the Fractur mapping dialog. The dialog is responsible to create an undo point in case of a modification.- Specified by:
openFacturMappingDialog
in interfaceDesignerDataModel
- Parameters:
searchterm
- the term to search in the factur mapping dialog, can be null
-
loadReportsFrom
public Engine[] loadReportsFrom(Component parent, URL initialURL) throws IOException, ReportException Loads one or more report. Choosing a location is the task of the programmer who may use any Swing component.- Specified by:
loadReportsFrom
in interfaceDesignerDataModel
- Parameters:
parent
- the parent component which should be used in dialogs.initialURL
- the initial URL for the FileChooser. This could a a location file URL or a HTTP URL of a repository.- Returns:
null
to indicate nothing was loaded (choice of the user) or an array of engines of the loaded report- Throws:
IOException
- to indicate nothing was loaded as the result of an IO problemReportException
- to indicate nothing was loaded as the result of a Report problem
-
saveOnRepository
public void saveOnRepository()Opens up a save dialog which enables the user to save a report onto the repository configured for the designer.- Specified by:
saveOnRepository
in interfaceDesignerDataModel
- See Also:
-
openFromRepository
public void openFromRepository()Opens a dialog enabling the user to choose a report file to open from the repository configured for the designer.- Specified by:
openFromRepository
in interfaceDesignerDataModel
- See Also:
-
createViewer
creates a newSwingReportViewer
and initializes it with the necessaryViewerContext
, as well as piping its log stream to the appropriate position (viaSwingReportViewer.setLoggingStream(java.io.PrintStream)
. It is recommended to first call the default implementation inAbstractDesignerDataModel
and then configure the created viewer to your liking if you are customizing this behavior.- Specified by:
createViewer
in interfaceDesignerDataModel
- Returns:
- new SwingReportViewer instance, fully initialized
-