public abstract class AbstractDesignerDataModel extends java.lang.Object implements DesignerDataModel
TYPE_COMMAND, TYPE_CONNECTION, TYPE_SPROC, TYPE_SPROC_WITH_PARAM, TYPE_SYSTEM_TABLE, TYPE_TABLE, TYPE_VIEW, TYPE_VIEW_WITH_PARAM
Constructor and Description |
---|
AbstractDesignerDataModel()
Initializes this DesignerDataModel implementation.
|
Modifier and Type | Method and Description |
---|---|
void |
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.
|
SwingReportViewer |
createViewer()
creates a new
SwingReportViewer and initializes it with the necessary ViewerContext , as well as piping its
log stream to the appropriate position (via SwingReportViewer.setLoggingStream(java.io.PrintStream) . |
java.io.File |
getApplicationDirectory()
Returns the location of the application directory which is the
directory where the designer is located in.
|
java.util.ArrayList<com.inet.font.FontFamily> |
getAvailableFonts()
Returns a list of all available fonts for the designer.
|
java.util.List<com.inet.font.FontFamily> |
getAvailableFontsFromRepository()
fetches a list of fonts available on the repository configured for the designer
|
boolean |
isAddElementAllowed(int elementType)
This method checks if its allowed to add a element to a report with the i-net Designer.
|
boolean |
isAddGroupAllowed()
This method checks if its allowed to add new groups to any report.
|
boolean |
isAddSectionAllowed()
This method checks if its allowed to add a new section to a report with the i-net Designer.
|
boolean |
isCloseAllowed()
This method checks if its allowed to close reports opened with the i-net Designer.
|
boolean |
isDataSourceManagerAllowed()
Returns whether the datasource manager dialog is accessible or not.
|
boolean |
isDatabaseChangeAllowed()
Check if the database configuration may be changed.
|
boolean |
isDatabaseObjectVisible(int databaseObjectType,
java.lang.String databaseObjectName)
Checks if the given database object should be visible in the database browser.
|
boolean |
isDesignNeedsConnection()
This method checks if the with the i-net Designer opened reports need a database connection.
|
boolean |
isInetTemplatesEnabled()
Returns true if the templates supplied through i-net will be enabled or not.
|
boolean |
isInvalidSPSelectable()
This method checks if a invalid connection is selectable in the virtual database dialog.
|
boolean |
isOpenAllowed()
Check if opening reports is allowed.
|
boolean |
isPreviewTabVisible()
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 |
isRemoveGroupAllowed()
This method checks if its allowed to remove a group from the report opened with the i-net Designer.
|
boolean |
isRemoveSectionAllowed()
This method checks if its allowed to remove section from a report with the i-net Designer.
|
boolean |
isReopenAllowed()
This method checks if its allowed to reopen a report with the i-net Designer.
|
boolean |
isReportWizardEnabled()
Returns true if a new report shall be created using the ReportWizard.
|
boolean |
isSaveAllowed()
Check if save is allowed.
|
boolean |
isSaveAsAllowed()
Check if save as is allowed.
|
boolean |
isTablesChangeAllowed()
Check if tables may be added or removed and if the links may be changed.
|
Engine[] |
loadReportsFrom(java.awt.Component parent,
java.net.URL initialURL)
Loads one or more report.
|
void |
openFacturMappingDialog(java.lang.String searchterm)
This method is called if the user wants to open the Fractur mapping dialog.
|
void |
openFromRepository()
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.
|
FormulaField |
openGroupSelectionFormulaDialog(FormulaField formulafield)
This method is called if the user wants to open the dialog for a group selection formula.
|
void |
openJavaBeanDialog()
This method is called if the user wants to open the Java Bean dialog.
|
void |
openPageLayoutDialog()
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.
|
FormulaField |
openRecordSelectionFormulaDialog(FormulaField formulafield)
This method is called if the user wants to open the dialog for a record selection formula.
|
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.
|
SQLField |
openSQLDialog(SQLField sqlField)
This method is called if the user wants to open the dialog for a SQL field.
|
void |
openSectionDialog(Section section)
This method is called if the user wants to open the Section dialog.
|
void |
openSortRecordsDialog()
This method is called if the user wants to open the Records dialog.
|
void |
openSubreportLinksDialog(java.lang.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 |
openSummaryInfoDialog()
This method is called if the user wants to open the Summary Info dialog.
|
FormulaField |
openUserFormulaDialog(FormulaField formulafield)
This method is called if the user wants to open the dialog for a user defined formula.
|
void |
openVisualDatabaseWizardDialog()
This method is called if the user wants to open the Visual Database Wizard dialog.
|
void |
openedSubreport(Engine engine)
This method is called if a subreport was opened by the user to edit it.
|
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.
|
Engine |
reopenReport(java.io.File reportFile)
Load a report.
|
void |
saveOnRepository()
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 |
setDataSourceManagerAllowed(boolean isAllowed)
Sets whether the datasource manager dialog shall be accessible or not.
|
void |
setDatabaseChangeAllowed(boolean databaseChangeAllowed)
Set if changes to the connection are allowed.
|
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.
|
createNewReport, loadReport, loadReportFrom, openPropertyFormulaDialog, saveReport
public AbstractDesignerDataModel()
public java.io.File getApplicationDirectory()
getApplicationDirectory
in interface DesignerDataModel
public boolean isReportWizardEnabled()
isReportWizardEnabled
in interface DesignerDataModel
public boolean isInetTemplatesEnabled()
isInetTemplatesEnabled
in interface DesignerDataModel
public java.util.ArrayList<com.inet.font.FontFamily> getAvailableFonts()
getAvailableFonts
in interface DesignerDataModel
public java.util.List<com.inet.font.FontFamily> getAvailableFontsFromRepository()
getAvailableFontsFromRepository
in interface DesignerDataModel
public boolean isPreviewTabVisible()
isPreviewTabVisible
in interface DesignerDataModel
true
if the preview tab should be visible otherwise false
public void setPreviewTabVisible(boolean previewTabVisible)
setPreviewTabVisible
in interface DesignerDataModel
previewTabVisible
- true
to allow, false
to denypublic boolean isDatabaseObjectVisible(int databaseObjectType, java.lang.String databaseObjectName)
isDatabaseObjectVisible
in interface DesignerDataModel
databaseObjectType
- The type of the database object. This will be one of the following table
, system table
, view
or stored procedure
databaseObjectName
- The name of the database object (e.g. of a table)true
public boolean isDatabaseChangeAllowed()
isDatabaseChangeAllowed
in interface DesignerDataModel
public boolean isOpenAllowed()
isOpenAllowed
in interface DesignerDataModel
public boolean isSaveAllowed()
isSaveAllowed
in interface DesignerDataModel
public boolean isSaveAsAllowed()
isSaveAsAllowed
in interface DesignerDataModel
public boolean isTablesChangeAllowed()
isTablesChangeAllowed
in interface DesignerDataModel
public void setDatabaseChangeAllowed(boolean databaseChangeAllowed)
setDatabaseChangeAllowed
in interface DesignerDataModel
databaseChangeAllowed
- true
to allow, false
to denypublic void setOpenAllowed(boolean openAllowed)
setOpenAllowed
in interface DesignerDataModel
openAllowed
- true
to allow, false
to denypublic void setSaveAllowed(boolean saveAllowed)
setSaveAllowed
in interface DesignerDataModel
saveAllowed
- true
to allow, false
to denypublic void setSaveAsAllowed(boolean saveAsAllowed)
setSaveAsAllowed
in interface DesignerDataModel
saveAsAllowed
- true
to allow, false
to denypublic void setTablesChangeAllowed(boolean tablesChangeAllowed)
setTablesChangeAllowed
in interface DesignerDataModel
tablesChangeAllowed
- true
to allow, false
to denypublic boolean isDesignNeedsConnection()
isDesignNeedsConnection
in interface DesignerDataModel
true
if the report needs a connection, false
if not.public void setDesignNeedsConnection(boolean designNeedsConnection)
setDesignNeedsConnection
in interface DesignerDataModel
designNeedsConnection
- true
if the report needs a connection, false
if not.public boolean isInvalidSPSelectable()
isInvalidSPSelectable
in interface DesignerDataModel
true
if invalid SPs are selectable, false
if not.public void setIsInvalidSPSelectable(boolean newSIISPS)
newSIISPS
- true
if invalid SPs are selectable, false
if not.public boolean isAddGroupAllowed()
isAddGroupAllowed
in interface DesignerDataModel
true
if its allowed to add new groups, false
if not.public void setAddGroupAllowed(boolean isAddGroupAllowed)
setAddGroupAllowed
in interface DesignerDataModel
isAddGroupAllowed
- true
if its allowed to add new groups, false
if not.public boolean isCloseAllowed()
isCloseAllowed
in interface DesignerDataModel
true
if its allowed to close the report, false
if not.public void setCloseAllowed(boolean isCloseAllowed)
setCloseAllowed
in interface DesignerDataModel
isCloseAllowed
- true
if its allowed to close the report, false
if not.public boolean isRemoveGroupAllowed()
isRemoveGroupAllowed
in interface DesignerDataModel
true
if its allowed to remove groups, false
if not.public void setRemoveGroupAllowed(boolean isRemoveGroupAllowed)
setRemoveGroupAllowed
in interface DesignerDataModel
isRemoveGroupAllowed
- true
if its allowed to remove groups, false
if not.public boolean isReopenAllowed()
isReopenAllowed
in interface DesignerDataModel
true
if its allowed to reopen a report, false
if not.public void setReopenAllowed(boolean isReopenAllowed)
setReopenAllowed
in interface DesignerDataModel
isReopenAllowed
- true
if its allowed to reopen a report, false
if not.public void setAddElementAllowed(boolean isAddElementAllowed, int elementType)
setAddElementAllowed
in interface DesignerDataModel
isAddElementAllowed
- true
if its allowed to add the element, false
if not.elementType
- Type of the element you want to allow/deny.Element.TEXT
,
Element.LINE
,
Element.BOX
,
Element.CROSSTAB
,
Element.CHART
,
Element.FIELD
,
Element.JAVABEAN
,
Element.SUBREPORT
,
Element.PICTURE
public boolean isAddElementAllowed(int elementType)
isAddElementAllowed
in interface DesignerDataModel
elementType
- Type of the element you want to allow/deny.Element.TEXT
,
Element.LINE
,
Element.BOX
,
Element.CROSSTAB
,
Element.CHART
,
Element.FIELD
,
Element.JAVABEAN
,
Element.SUBREPORT
,
Element.PICTURE
public void setRemoveElementAllowed(boolean isRemoveElementAllowed, int elementType)
setRemoveElementAllowed
in interface DesignerDataModel
isRemoveElementAllowed
- true
if its allowed to remove the element, false
if not.elementType
- Type of the element you want to allow/deny.Element.TEXT
,
Element.LINE
,
Element.BOX
,
Element.CROSSTAB
,
Element.CHART
,
Element.FIELD
,
Element.JAVABEAN
,
Element.SUBREPORT
,
Element.PICTURE
public boolean isRemoveElementAllowed(int elementType)
isRemoveElementAllowed
in interface DesignerDataModel
elementType
- Type of the element you want to allow/deny.Element.TEXT
,
Element.LINE
,
Element.BOX
,
Element.CROSSTAB
,
Element.CHART
,
Element.FIELD
,
Element.JAVABEAN
,
Element.SUBREPORT
,
Element.PICTURE
public boolean isAddSectionAllowed()
isAddSectionAllowed
in interface DesignerDataModel
true
if its allowed to add a section to a report, false
if not.public void setAddSectionAllowed(boolean isAddSectionAllowed)
setAddSectionAllowed
in interface DesignerDataModel
isAddSectionAllowed
- true
if its allowed to add a section to a report, false
if
not.public boolean isRemoveSectionAllowed()
isRemoveSectionAllowed
in interface DesignerDataModel
true
if its allowed to remove a section from a report, false
if not.public void setRemoveSectionAllowed(boolean isRemoveSectionAllowed)
setRemoveSectionAllowed
in interface DesignerDataModel
isRemoveSectionAllowed
- true
if its allowed to remove a section from a report,
false
if not.public void openParameterDialog(PromptField parameterField)
openParameterDialog
in interface DesignerDataModel
parameterField
- The parameter field if already existent, otherwise null
Note: Since version 7.0 this method does not return the modified
field anymore.public SQLField openSQLDialog(SQLField sqlField)
openSQLDialog
in interface DesignerDataModel
sqlField
- The SQL field if already existent, otherwise nullpublic void openSumDialog(SummaryField sumfield)
openSumDialog
in interface DesignerDataModel
sumfield
- The parameter field if already existent, otherwise nullpublic void openGroupDialog(Group group)
openGroupDialog
in interface DesignerDataModel
group
- The group if already existent, otherwise nullpublic void openSummaryInfoDialog()
openSummaryInfoDialog
in interface DesignerDataModel
public void openSortRecordsDialog()
openSortRecordsDialog
in interface DesignerDataModel
public void openSubreportLinksDialog(java.lang.String reportName)
openSubreportLinksDialog
in interface DesignerDataModel
reportName
- Name of the subreport or null if no subreport was selectedpublic void openSectionDialog(Section section)
openSectionDialog
in interface DesignerDataModel
section
- the selected section or null if no section was selectedpublic void openVisualDatabaseWizardDialog()
openVisualDatabaseWizardDialog
in interface DesignerDataModel
public void openJavaBeanDialog()
openJavaBeanDialog
in interface DesignerDataModel
public FormulaField openUserFormulaDialog(FormulaField formulafield)
openUserFormulaDialog
in interface DesignerDataModel
formulafield
- The formula field if already existent, otherwise nullpublic FormulaField openRecordSelectionFormulaDialog(FormulaField formulafield)
openRecordSelectionFormulaDialog
in interface DesignerDataModel
formulafield
- The formulafield if it already exists, otherwise nullpublic FormulaField openGroupSelectionFormulaDialog(FormulaField formulafield)
openGroupSelectionFormulaDialog
in interface DesignerDataModel
formulafield
- The formulafield if already existent, otherwise nullpublic void closedReport(Engine engine)
closedReport
in interface DesignerDataModel
engine
- the engine of the closed report.public void addedSubreport(Engine engine)
addedSubreport
in interface DesignerDataModel
engine
- the engine of the added subreport.public void removedSubreport(Engine engine)
removedSubreport
in interface DesignerDataModel
engine
- the engine of the removed subreport.public void openedSubreport(Engine engine)
openedSubreport
in interface DesignerDataModel
engine
- the engine of the opened subreport.public void closedSubreport(Engine engine)
closedSubreport
in interface DesignerDataModel
engine
- the engine of the closed subreport.public void addedGroup(Group group)
addedGroup
in interface DesignerDataModel
group
- the added group.public void removedGroup(Group group)
removedGroup
in interface DesignerDataModel
group
- the removed group.public void addedElement(Element element)
addedElement
in interface DesignerDataModel
element
- the added element.public void removedElement(Element element)
removedElement
in interface DesignerDataModel
element
- the removed element.public Engine reopenReport(java.io.File reportFile) throws ReportException
reopenReport
in interface DesignerDataModel
reportFile
- the file object which contains the path to the report.ReportException
- to indicate nothing was loaded as the result of a Report problempublic void openPageLayoutDialog()
openPageLayoutDialog
in interface DesignerDataModel
public boolean isDataSourceManagerAllowed()
isDataSourceManagerAllowed
in interface DesignerDataModel
public void setDataSourceManagerAllowed(boolean isAllowed)
setDataSourceManagerAllowed
in interface DesignerDataModel
isAllowed
- True if the datasource manager dialog should be
accessible false otherwise.public void openRepositoryConfigDialog()
openRepositoryConfigDialog
in interface DesignerDataModel
DesignerDataModel.saveOnRepository()
,
DesignerDataModel.openFromRepository()
public void openFacturMappingDialog(java.lang.String searchterm)
openFacturMappingDialog
in interface DesignerDataModel
searchterm
- the term to search in the factur mapping dialog, can be nullpublic Engine[] loadReportsFrom(java.awt.Component parent, java.net.URL initialURL) throws java.io.IOException, ReportException
loadReportsFrom
in interface DesignerDataModel
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.null
to indicate nothing was loaded (choice of the
user) or an array of engines of the loaded reportjava.io.IOException
- to indicate nothing was loaded as the result of an IO problemReportException
- to indicate nothing was loaded as the result of a Report problempublic void saveOnRepository()
saveOnRepository
in interface DesignerDataModel
DesignerDataModel.openRepositoryConfigDialog()
,
DesignerDataModel.openFromRepository()
public void openFromRepository()
openFromRepository
in interface DesignerDataModel
DesignerDataModel.openRepositoryConfigDialog()
,
DesignerDataModel.saveOnRepository()
public SwingReportViewer createViewer()
SwingReportViewer
and initializes it with the necessary ViewerContext
, as well as piping its
log stream to the appropriate position (via SwingReportViewer.setLoggingStream(java.io.PrintStream)
. It is recommended to
first call the default implementation in AbstractDesignerDataModel
and then
configure the created viewer to your liking if you are customizing this behavior.createViewer
in interface DesignerDataModel
Copyright © 1999-2020 by i-net software GmbH