1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
|
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
package com.sun.star.wizards.report;
import com.sun.star.beans.PropertyValue;
import com.sun.star.lang.XComponent;
import com.sun.star.lang.XMultiServiceFactory;
import com.sun.star.sdb.application.XDatabaseDocumentUI;
import com.sun.star.wizards.common.Resource;
import java.util.ArrayList;
import java.util.Vector;
/**
* New Interface which gives us the possibility to switch on the fly between the old
* Wizard and the new Sun Report Builder Wizard, which use the same UI.
*
* @author ll93751
*/
public interface IReportDocument
{
// -------------------------------------------------------------------------
// initialisation
// -------------------------------------------------------------------------
public void initialize(
final XDatabaseDocumentUI i_documentUI,
final Resource i_resource
);
// -------------------------------------------------------------------------
// Access Helper
// -------------------------------------------------------------------------
/**
* Gives access to the DB Values
* @return
*/
public com.sun.star.wizards.db.RecordParser getRecordParser();
/**
* Give access to the parent document
* It is a document in the old Wizard
* It is a Report Builder in the new Wizard
* @return
*/
public com.sun.star.awt.XWindowPeer getWizardParent();
/**
*
* @return the Frame of the document Window or Report Builder Window
*/
public com.sun.star.frame.XFrame getFrame();
public XComponent getComponent();
// -------------------------------------------------------------------------
// First step: After entering the table name, select fields
// -------------------------------------------------------------------------
/**
* Is called after first step, set Tablename and the fields, which should occur in the Report.
* @param _aType
* @param TableName
* @param FieldNames
*/
public void initializeFieldColumns(final int _aType, final String TableName, final String[] FieldNames);
/**
* Empties the report document
*/
public void clearDocument();
/**
* Empties the report document, if we called back, don't remove Grouping/Sorting
*/
public void removeTextTableAndTextSection();
// -------------------------------------------------------------------------
// Second step: Label field titles
// -------------------------------------------------------------------------
/**
* Set new names for the titles
* @param sFieldTitles
*/
public void setFieldTitles(final String[] sFieldTitles);
/**
* Change a the name of the 'title' of one field.
* It is possible to give all element names new names which are used as
* element title of a given element name.
* This is only used as a preview
* @param FieldName
* @param TitleName
*/
public void liveupdate_changeUserFieldContent(final String FieldName, final String TitleName);
// -------------------------------------------------------------------------
// Third step: Grouping
// -------------------------------------------------------------------------
/* Grouping Page */
// Document should not hold the grouping information!
/**
* Called by press ('greater then') add a group to the group list
* @param GroupNames
* @param CurGroupTitle
* @param GroupFieldVector
* @param ReportPath
* @param iSelCount
* @return
*/
public boolean liveupdate_addGroupNametoDocument(String[] GroupNames, String CurGroupTitle, ArrayList GroupFieldVector, ArrayList ReportPath, int iSelCount);
public void refreshGroupFields(String[] _sNewNames);
// public boolean isGroupField(String _FieldName);
/**
* Called by press ('less then') Removes an already set Groupname out of the list
* @param NewSelGroupNames
* @param CurGroupTitle
* @param GroupFieldVector
*/
public void liveupdate_removeGroupName(String[] NewSelGroupNames, String CurGroupTitle, java.util.ArrayList GroupFieldVector);
/**
* set the list how to group
* @param aGroupList
*/
public void setGrouping(String[] aGroupList);
// -------------------------------------------------------------------------
// Fourth step: Sorting
// -------------------------------------------------------------------------
/**
* Set the list how to sort
* @param aSort
*/
public void setSorting(String[][] aSort);
// -------------------------------------------------------------------------
// Fivth step: Templates / Layout
// -------------------------------------------------------------------------
/* Template Page */
public void setPageOrientation(int nOrientation) throws com.sun.star.lang.IllegalArgumentException;
public int getDefaultPageOrientation();
public ArrayList getReportPath();
public String getLayoutPath();
public String getContentPath();
/**
* Called if a new Layout is selected
* @param LayoutTemplatePath
*/
public void liveupdate_changeLayoutTemplate(String LayoutTemplatePath/*, String BitmapPath*/);
/**
* Called if a new Template is selected
* @param ContentTemplatePath
*/
public void liveupdate_changeContentTemplate(String ContentTemplatePath);
// public String[] getLayoutTemplates();
// public String[] getContentTemplates();
public void layout_selectFirstPage();
public void layout_setupRecordSection(String TemplateName);
// -------------------------------------------------------------------------
// finishing
// -------------------------------------------------------------------------
// preview (update titlenames)
// addTextListener
/**
* Set the Title into the document from the 'Create Report Page'
* BUG: The Title is empty after create Report.
* @param _sTitleName
*/
public void liveupdate_updateReportTitle(String _sTitleName);
/**
* Store the document by the given name
* @param Name
* @param OpenMode
*/
public void store(String Name, int OpenMode) throws com.sun.star.uno.Exception;
/**
* The current report is added to the DB View under the given name
*
* TODO: add Name to this functionality
*/
public void addReportToDBView();
public void importReportData(ReportWizard aWizard);
/**
* Create the final Report document
* @param Name
* @param _bAsTemplate
* @param _bOpenInDesign
* @return
*/
public void createAndOpenReportDocument(
final String Name,
final boolean _bAsTemplate,
final boolean _bOpenInDesign
);
public void dispose();
// -------------------------------------------------------------------------
// Garbage dump
// -------------------------------------------------------------------------
/* DataImport */
// ???
// public void addTextSectionCopies();
// ???
public boolean reconnectToDatabase(XMultiServiceFactory xMSF, PropertyValue[] Properties);
// ???
public void insertDatabaseDatatoReportDocument(XMultiServiceFactory xMSF);
// ???
// public com.sun.star.lang.XMultiServiceFactory getDocumentServiceFactory();
/**
* set a internal variable to stop a maybe longer DB access.
*/
public void StopProcess(); // cancel
/**
* Returns a string list of layouts.
* @return
*/
public String[][] getDataLayout();
/**
* Returns a string list of header layouts
* @return
*/
public String[][] getHeaderLayout();
public void setCommandType(int CommandType);
public void setCommand(String Command);
/**
* check internal invariants
* @throws a
*/
public void checkInvariants() throws java.lang.Exception;
}
|