extensions/source/dbpilots/listcombowizard.cxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #include "listcombowizard.hxx"
  21 #include "commonpagesdbp.hxx"
  22 #include <com/sun/star/sdbc/XConnection.hpp>
  23 #include <com/sun/star/sdbcx/XTablesSupplier.hpp>
  24 #include <com/sun/star/container/XNameAccess.hpp>
  25 #include <com/sun/star/form/ListSourceType.hpp>
  26 #include <com/sun/star/sdbcx/XColumnsSupplier.hpp>
  27 #include <tools/debug.hxx>
  28 #include <tools/diagnose_ex.h>
  29 #include <connectivity/dbtools.hxx>
  30 #include <helpids.h>
  31 #include <sal/log.hxx>
  32 #include <osl/diagnose.h>
  33
  34
  35 namespace dbp
  36 {
  37
  38
  39     using namespace ::com::sun::star::uno;
  40     using namespace ::com::sun::star::lang;
  41     using namespace ::com::sun::star::beans;
  42     using namespace ::com::sun::star::sdbc;
  43     using namespace ::com::sun::star::sdbcx;
  44     using namespace ::com::sun::star::container;
  45     using namespace ::com::sun::star::form;
  46     using namespace ::svt;
  47     using namespace ::dbtools;
  48
  49     OListComboWizard::OListComboWizard( vcl::Window* _pParent,
  50             const Reference< XPropertySet >& _rxObjectModel, const Reference< XComponentContext >& _rxContext )
  51         :OControlWizard(_pParent, _rxObjectModel, _rxContext)
  52         ,m_bListBox(false)
  53         ,m_bHadDataSelection(true)
  54     {
  55         initControlSettings(&m_aSettings);
  56
  57         m_pPrevPage->SetHelpId(HID_LISTWIZARD_PREVIOUS);
  58         m_pNextPage->SetHelpId(HID_LISTWIZARD_NEXT);
  59         m_pCancel->SetHelpId(HID_LISTWIZARD_CANCEL);
  60         m_pFinish->SetHelpId(HID_LISTWIZARD_FINISH);
  61
  62         // if we do not need the data source selection page ...
  63         if (!needDatasourceSelection())
  64         {   // ... skip it!
  65             skip();
  66             m_bHadDataSelection = false;
  67         }
  68     }
  69
  70
  71     bool OListComboWizard::approveControl(sal_Int16 _nClassId)
  72     {
  73         switch (_nClassId)
  74         {
  75             case FormComponentType::LISTBOX:
  76                 m_bListBox = true;
  77                 setTitleBase(compmodule::ModuleRes(RID_STR_LISTWIZARD_TITLE));
  78                 return true;
  79             case FormComponentType::COMBOBOX:
  80                 m_bListBox = false;
  81                 setTitleBase(compmodule::ModuleRes(RID_STR_COMBOWIZARD_TITLE));
  82                 return true;
  83         }
  84         return false;
  85     }
  86
  87
  88     VclPtr<TabPage> OListComboWizard::createPage(WizardState _nState)
  89     {
  90         switch (_nState)
  91         {
  92             case LCW_STATE_DATASOURCE_SELECTION:
  93                 return VclPtr<OTableSelectionPage>::Create(this);
  94             case LCW_STATE_TABLESELECTION:
  95                 return VclPtr<OContentTableSelection>::Create(this);
  96             case LCW_STATE_FIELDSELECTION:
  97                 return VclPtr<OContentFieldSelection>::Create(this);
  98             case LCW_STATE_FIELDLINK:
  99                 return VclPtr<OLinkFieldsPage>::Create(this);
 100             case LCW_STATE_COMBODBFIELD:
 101                 return VclPtr<OComboDBFieldPage>::Create(this);
 102         }
 103
 104         return VclPtr<TabPage>();
 105     }
 106
 107
 108     WizardTypes::WizardState OListComboWizard::determineNextState( WizardState _nCurrentState ) const
 109     {
 110         switch (_nCurrentState)
 111         {
 112             case LCW_STATE_DATASOURCE_SELECTION:
 113                 return LCW_STATE_TABLESELECTION;
 114             case LCW_STATE_TABLESELECTION:
 115                 return LCW_STATE_FIELDSELECTION;
 116             case LCW_STATE_FIELDSELECTION:
 117                 return getFinalState();
 118         }
 119
 120         return WZS_INVALID_STATE;
 121     }
 122
 123
 124     void OListComboWizard::enterState(WizardState _nState)
 125     {
 126         OControlWizard::enterState(_nState);
 127
 128         enableButtons(WizardButtonFlags::PREVIOUS, m_bHadDataSelection ? (LCW_STATE_DATASOURCE_SELECTION < _nState) : LCW_STATE_TABLESELECTION < _nState);
 129         enableButtons(WizardButtonFlags::NEXT, getFinalState() != _nState);
 130         if (_nState < getFinalState())
 131             enableButtons(WizardButtonFlags::FINISH, false);
 132
 133         if (getFinalState() == _nState)
 134             defaultButton(WizardButtonFlags::FINISH);
 135     }
 136
 137
 138     bool OListComboWizard::leaveState(WizardState _nState)
 139     {
 140         if (!OControlWizard::leaveState(_nState))
 141             return false;
 142
 143         if (getFinalState() == _nState)
 144             defaultButton(WizardButtonFlags::NEXT);
 145
 146         return true;
 147     }
 148
 149
 150     void OListComboWizard::implApplySettings()
 151     {
 152         try
 153         {
 154             // for quoting identifiers, we need the connection meta data
 155             Reference< XConnection > xConn = getFormConnection();
 156             DBG_ASSERT(xConn.is(), "OListComboWizard::implApplySettings: no connection, unable to quote!");
 157             Reference< XDatabaseMetaData > xMetaData;
 158             if (xConn.is())
 159                 xMetaData = xConn->getMetaData();
 160
 161             // do some quotings
 162             if (xMetaData.is())
 163             {
 164                 OUString sQuoteString = xMetaData->getIdentifierQuoteString();
 165                 if (isListBox()) // only when we have a listbox this should be not empty
 166                     getSettings().sLinkedListField = quoteName(sQuoteString, getSettings().sLinkedListField);
 167
 168                 OUString sCatalog, sSchema, sName;
 169                 ::dbtools::qualifiedNameComponents( xMetaData, getSettings().sListContentTable, sCatalog, sSchema, sName, ::dbtools::EComposeRule::InDataManipulation );
 170                 getSettings().sListContentTable = ::dbtools::composeTableNameForSelect( xConn, sCatalog, sSchema, sName );
 171
 172                 getSettings().sListContentField = quoteName(sQuoteString, getSettings().sListContentField);
 173             }
 174
 175             // ListSourceType: SQL
 176             getContext().xObjectModel->setPropertyValue("ListSourceType", makeAny(sal_Int32(ListSourceType_SQL)));
 177
 178             if (isListBox())
 179             {
 180                 // BoundColumn: 1
 181                 getContext().xObjectModel->setPropertyValue("BoundColumn", makeAny(sal_Int16(1)));
 182
 183                 // build the statement to set as list source
 184                 OUString sStatement = "SELECT " +
 185                     getSettings().sListContentField +  ", " + getSettings().sLinkedListField +
 186                     " FROM " + getSettings().sListContentTable;
 187                 Sequence< OUString > aListSource { sStatement };
 188                 getContext().xObjectModel->setPropertyValue("ListSource", makeAny(aListSource));
 189             }
 190             else
 191             {
 192                 // build the statement to set as list source
 193                 OUString sStatement = "SELECT DISTINCT " +
 194                     getSettings().sListContentField +
 195                     " FROM " + getSettings().sListContentTable;
 196                 getContext().xObjectModel->setPropertyValue( "ListSource", makeAny(sStatement));
 197             }
 198
 199             // the bound field
 200             getContext().xObjectModel->setPropertyValue("DataField", makeAny(getSettings().sLinkedFormField));
 201         }
 202         catch(const Exception&)
 203         {
 204             OSL_FAIL("OListComboWizard::implApplySettings: could not set the property values for the listbox!");
 205         }
 206     }
 207
 208
 209     bool OListComboWizard::onFinish()
 210     {
 211         if ( !OControlWizard::onFinish() )
 212             return false;
 213
 214         implApplySettings();
 215         return true;
 216     }
 217
 218     Reference< XNameAccess > OLCPage::getTables()
 219     {
 220         Reference< XConnection > xConn = getFormConnection();
 221         DBG_ASSERT(xConn.is(), "OLCPage::getTables: should have an active connection when reaching this page!");
 222
 223         Reference< XTablesSupplier > xSuppTables(xConn, UNO_QUERY);
 224         Reference< XNameAccess > xTables;
 225         if (xSuppTables.is())
 226             xTables = xSuppTables->getTables();
 227
 228         DBG_ASSERT(xTables.is() || !xConn.is(), "OLCPage::getTables: got no tables from the connection!");
 229
 230         return xTables;
 231     }
 232
 233
 234     Sequence< OUString > OLCPage::getTableFields()
 235     {
 236         Reference< XNameAccess > xTables = getTables();
 237         Sequence< OUString > aColumnNames;
 238         if (xTables.is())
 239         {
 240             try
 241             {
 242                 // the list table as XColumnsSupplier
 243                 Reference< XColumnsSupplier > xSuppCols;
 244                 xTables->getByName(getSettings().sListContentTable) >>= xSuppCols;
 245                 DBG_ASSERT(xSuppCols.is(), "OLCPage::getTableFields: no columns supplier!");
 246
 247                 // the columns
 248                 Reference< XNameAccess > xColumns;
 249                 if (xSuppCols.is())
 250                     xColumns = xSuppCols->getColumns();
 251
 252                 // the column names
 253                 if (xColumns.is())
 254                     aColumnNames = xColumns->getElementNames();
 255             }
 256             catch(const Exception&)
 257             {
 258                 css::uno::Any ex( cppu::getCaughtException() );
 259                 SAL_WARN( "extensions.dbpilots", "OLinkFieldsPage::initializePage: caught an exception while retrieving the columns! " << exceptionToString(ex));
 260             }
 261         }
 262         return aColumnNames;
 263     }
 264
 265     OContentTableSelection::OContentTableSelection( OListComboWizard* _pParent )
 266         :OLCPage(_pParent, "TableSelectionPage", "modules/sabpilot/ui/contenttablepage.ui")
 267     {
 268         get(m_pSelectTable, "table");
 269
 270         enableFormDatasourceDisplay();
 271
 272         m_pSelectTable->SetDoubleClickHdl(LINK(this, OContentTableSelection, OnTableDoubleClicked));
 273         m_pSelectTable->SetSelectHdl(LINK(this, OContentTableSelection, OnTableSelected));
 274     }
 275
 276     OContentTableSelection::~OContentTableSelection()
 277     {
 278         disposeOnce();
 279     }
 280
 281     void OContentTableSelection::dispose()
 282     {
 283         m_pSelectTable.clear();
 284         OLCPage::dispose();
 285     }
 286
 287     void OContentTableSelection::ActivatePage()
 288     {
 289         OLCPage::ActivatePage();
 290         m_pSelectTable->GrabFocus();
 291     }
 292
 293
 294     bool OContentTableSelection::canAdvance() const
 295     {
 296         if (!OLCPage::canAdvance())
 297             return false;
 298
 299         return 0 != m_pSelectTable->GetSelectedEntryCount();
 300     }
 301
 302
 303     IMPL_LINK_NOARG( OContentTableSelection, OnTableSelected, ListBox&, void )
 304     {
 305         updateDialogTravelUI();
 306     }
 307
 308
 309     IMPL_LINK( OContentTableSelection, OnTableDoubleClicked, ListBox&, _rListBox, void )
 310     {
 311         if (_rListBox.GetSelectedEntryCount())
 312             getDialog()->travelNext();
 313     }
 314
 315
 316     void OContentTableSelection::initializePage()
 317     {
 318         OLCPage::initializePage();
 319
 320         // fill the list with the table name
 321         m_pSelectTable->Clear();
 322         try
 323         {
 324             Reference< XNameAccess > xTables = getTables();
 325             Sequence< OUString > aTableNames;
 326             if (xTables.is())
 327                 aTableNames = xTables->getElementNames();
 328             fillListBox(*m_pSelectTable, aTableNames);
 329         }
 330         catch(const Exception&)
 331         {
 332             OSL_FAIL("OContentTableSelection::initializePage: could not retrieve the table names!");
 333         }
 334
 335         m_pSelectTable->SelectEntry(getSettings().sListContentTable);
 336     }
 337
 338
 339     bool OContentTableSelection::commitPage( ::svt::WizardTypes::CommitPageReason _eReason )
 340     {
 341         if (!OLCPage::commitPage(_eReason))
 342             return false;
 343
 344         OListComboSettings& rSettings = getSettings();
 345         rSettings.sListContentTable = m_pSelectTable->GetSelectedEntry();
 346         if (rSettings.sListContentTable.isEmpty() && (::svt::WizardTypes::eTravelBackward != _eReason))
 347             // need to select a table
 348             return false;
 349
 350         return true;
 351     }
 352
 353     OContentFieldSelection::OContentFieldSelection( OListComboWizard* _pParent )
 354         :OLCPage(_pParent, "FieldSelectionPage", "modules/sabpilot/ui/contentfieldpage.ui")
 355     {
 356         get(m_pSelectTableField, "selectfield");
 357         get(m_pDisplayedField, "displayfield");
 358         get(m_pInfo, "info");
 359         m_pInfo->SetText(compmodule::ModuleRes( isListBox() ? RID_STR_FIELDINFO_LISTBOX : RID_STR_FIELDINFO_COMBOBOX));
 360         m_pSelectTableField->SetSelectHdl(LINK(this, OContentFieldSelection, OnFieldSelected));
 361         m_pSelectTableField->SetDoubleClickHdl(LINK(this, OContentFieldSelection, OnTableDoubleClicked));
 362     }
 363
 364     OContentFieldSelection::~OContentFieldSelection()
 365     {
 366         disposeOnce();
 367     }
 368
 369     void OContentFieldSelection::dispose()
 370     {
 371         m_pSelectTableField.clear();
 372         m_pDisplayedField.clear();
 373         m_pInfo.clear();
 374         OLCPage::dispose();
 375     }
 376
 377
 378     void OContentFieldSelection::initializePage()
 379     {
 380         OLCPage::initializePage();
 381
 382         // fill the list of fields
 383         fillListBox(*m_pSelectTableField, getTableFields());
 384
 385         m_pSelectTableField->SelectEntry(getSettings().sListContentField);
 386         m_pDisplayedField->SetText(getSettings().sListContentField);
 387     }
 388
 389
 390     bool OContentFieldSelection::canAdvance() const
 391     {
 392         if (!OLCPage::canAdvance())
 393             return false;
 394
 395         return 0 != m_pSelectTableField->GetSelectedEntryCount();
 396     }
 397
 398
 399     IMPL_LINK_NOARG( OContentFieldSelection, OnTableDoubleClicked, ListBox&, void )
 400     {
 401         if (m_pSelectTableField->GetSelectedEntryCount())
 402             getDialog()->travelNext();
 403     }
 404
 405
 406     IMPL_LINK_NOARG( OContentFieldSelection, OnFieldSelected, ListBox&, void )
 407     {
 408         updateDialogTravelUI();
 409         m_pDisplayedField->SetText(m_pSelectTableField->GetSelectedEntry());
 410     }
 411
 412
 413     bool OContentFieldSelection::commitPage( ::svt::WizardTypes::CommitPageReason _eReason )
 414     {
 415         if (!OLCPage::commitPage(_eReason))
 416             return false;
 417
 418         getSettings().sListContentField = m_pSelectTableField->GetSelectedEntry();
 419
 420         return true;
 421     }
 422
 423     OLinkFieldsPage::OLinkFieldsPage( OListComboWizard* _pParent )
 424         :OLCPage(_pParent, "FieldLinkPage", "modules/sabpilot/ui/fieldlinkpage.ui")
 425     {
 426         get(m_pValueListField, "valuefield");
 427         get(m_pTableField, "listtable");
 428
 429         m_pValueListField->SetModifyHdl(LINK(this, OLinkFieldsPage, OnSelectionModified));
 430         m_pTableField->SetModifyHdl(LINK(this, OLinkFieldsPage, OnSelectionModified));
 431         m_pValueListField->SetSelectHdl(LINK(this, OLinkFieldsPage, OnSelectionModifiedCombBox));
 432         m_pTableField->SetSelectHdl(LINK(this, OLinkFieldsPage, OnSelectionModifiedCombBox));
 433     }
 434
 435     OLinkFieldsPage::~OLinkFieldsPage()
 436     {
 437         disposeOnce();
 438     }
 439
 440     void OLinkFieldsPage::dispose()
 441     {
 442         m_pValueListField.clear();
 443         m_pTableField.clear();
 444         OLCPage::dispose();
 445     }
 446
 447     void OLinkFieldsPage::ActivatePage()
 448     {
 449         OLCPage::ActivatePage();
 450         m_pValueListField->GrabFocus();
 451     }
 452
 453
 454     void OLinkFieldsPage::initializePage()
 455     {
 456         OLCPage::initializePage();
 457
 458         // fill the value list
 459         fillListBox(*m_pValueListField, getContext().aFieldNames);
 460         // fill the table field list
 461         fillListBox(*m_pTableField, getTableFields());
 462
 463         // the initial selections
 464         m_pValueListField->SetText(getSettings().sLinkedFormField);
 465         m_pTableField->SetText(getSettings().sLinkedListField);
 466
 467         implCheckFinish();
 468     }
 469
 470
 471     bool OLinkFieldsPage::canAdvance() const
 472     {
 473         // we're on the last page here, no travelNext allowed ...
 474         return false;
 475     }
 476
 477
 478     void OLinkFieldsPage::implCheckFinish()
 479     {
 480         bool bInvalidSelection = (COMBOBOX_ENTRY_NOTFOUND == m_pValueListField->GetEntryPos(m_pValueListField->GetText()));
 481         bInvalidSelection |= (COMBOBOX_ENTRY_NOTFOUND == m_pTableField->GetEntryPos(m_pTableField->GetText()));
 482         getDialog()->enableButtons(WizardButtonFlags::FINISH, !bInvalidSelection);
 483     }
 484
 485
 486     IMPL_LINK_NOARG(OLinkFieldsPage, OnSelectionModified, Edit&, void)
 487     {
 488         implCheckFinish();
 489     }
 490
 491     IMPL_LINK_NOARG(OLinkFieldsPage, OnSelectionModifiedCombBox, ComboBox&, void)
 492     {
 493         implCheckFinish();
 494     }
 495
 496     bool OLinkFieldsPage::commitPage( ::svt::WizardTypes::CommitPageReason _eReason )
 497     {
 498         if (!OLCPage::commitPage(_eReason))
 499             return false;
 500
 501         getSettings().sLinkedFormField = m_pValueListField->GetText();
 502         getSettings().sLinkedListField = m_pTableField->GetText();
 503
 504         return true;
 505     }
 506
 507     OComboDBFieldPage::OComboDBFieldPage( OControlWizard* _pParent )
 508         :ODBFieldPage(_pParent)
 509     {
 510         setDescriptionText(compmodule::ModuleRes(RID_STR_COMBOWIZ_DBFIELD));
 511     }
 512
 513     OUString& OComboDBFieldPage::getDBFieldSetting()
 514     {
 515         return static_cast<OListComboWizard*>(getDialog())->getSettings().sLinkedFormField;
 516     }
 517
 518     void OComboDBFieldPage::ActivatePage()
 519     {
 520         ODBFieldPage::ActivatePage();
 521         getDialog()->enableButtons(WizardButtonFlags::FINISH, true);
 522     }
 523
 524     bool OComboDBFieldPage::canAdvance() const
 525     {
 526         // we're on the last page here, no travelNext allowed ...
 527         return false;
 528     }
 529
 530 }   // namespace dbp
 531
 532
 533 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */