View source for API/UNO AWT/Grid Control

From Apache OpenOffice Wiki

← API/UNO AWT/Grid Control

You do not have permission to edit this page, for the following reasons:

• The action you have requested is limited to users in the group: Users.
• You must confirm your email address before editing pages. Please set and validate your email address through your user preferences.

---

You can view and copy the source of this page.

{{DISPLAYTITLE:UNO Grid Control}} =Abstract= OpenOffice.org hasn't a Grid Control via UNO API today. The goal is to develop and implement an UNO Grid Control. This Wiki page should help you to implement a UNO Grid Control within your own UNO application. == Overview == [[Image:Overview_gridcontrol.png]] == Example == '''Create new columns:''' ''Java'' <source lang="java"> // #1 column Object column1Obj = xMultiComponentFactory.createInstanceWithContext( "com.sun.star.awt.grid.GridColumn", m_xContext); XGridColumn column1 = (XGridColumn) UnoRuntime.queryInterface( XGridColumn.class, column1Obj); column1.setTitle("Column1"); // #2 column Object column2Obj = xMultiComponentFactory.createInstanceWithContext( "com.sun.star.awt.grid.GridColumn", m_xContext); XGridColumn column2 = (XGridColumn) UnoRuntime.queryInterface( XGridColumn.class, column2Obj); column2.setTitle("Column2"); </source> ''Basic'' <source lang="oobas"> oColumnModel = createUnoService( "com.sun.star.awt.grid.DefaultGridColumnModel") oColumn1 = createUnoService( "com.sun.star.awt.grid.GridColumn") oColumn1.Title = "City" oColumn2 = createUnoService( "com.sun.star.awt.grid.GridColumn") oColumn2.Title = "Country" </source> '''Add the columns to the column model of the grid control:''' ''Java'' <source lang="java"> Object columnModel = xMultiComponentFactory.createInstanceWithContext( "com.sun.star.awt.grid.DefaultGridColumnModel", m_xContext); XGridColumnModel xGridColumnModel = (XGridColumnModel) UnoRuntime.queryInterface( XGridColumnModel.class, columnModel); xGridColumnModel.addColumn(column1); xGridColumnModel.addColumn(column2); </source> ''Basic'' <source lang="oobas"> oColumnModel.addColumn( oColumn1 ) oColumnModel.addColumn( oColumn2 ) </source> '''Use the data model of the grid control to add rows:''' ''Java'' <source lang="java"> Object dataModel = xMultiComponentFactory.createInstanceWithContext( "com.sun.star.awt.grid.DefaultGridDataModel", m_xContext); XGridDataModel xGridDataModel = (XGridDataModel) UnoRuntime.queryInterface( XGridDataModel.class, dataModel); xGridDataModel.addRow("1", new String[] {"1,1","1,2"} ); xGridDataModel.addRow("2", new String[] {"2,1","2,2"} ); </source> ''Basic'' <source lang="oobas"> oDataModel = createUnoService( "com.sun.star.awt.grid.DefaultGridDataModel") 'first parameter is for header title if row header exists, else put empty string oDataModel.addRow ( "1", Array( "Hamburg", "Germany") ) oDataModel.addRow ( "2", Array("Brisbane", "Australia") ) </source> '''Create the grid model and assign the column and data model:''' ''Java'' <source lang="java"> Object gridModel = xMultiServiceFactory.createInstance( "com.sun.star.awt.grid.UnoControlGridModel"); XPropertySet xPSetButton = (XPropertySet) UnoRuntime.queryInterface( XPropertySet.class, gridModel); xPSetButton.setPropertyValue("PositionX", new Integer(50)); xPSetButton.setPropertyValue("PositionY", new Integer(30)); xPSetButton.setPropertyValue("Width", new Integer(400)); xPSetButton.setPropertyValue("Height", new Integer(400)); xPSetButton.setPropertyValue("Name", "GridControl"); xPSetButton.setPropertyValue("TabIndex", new Short((short) 0)); xPSetButton.setPropertyValue("ColumnModel", xGridColumnModel); xPSetButton.setPropertyValue("GridDataModel", xGridDataModel); </source> ''Basic'' <source lang="oobas"> oModel = oDialogModel.createInstance( "com.sun.star.awt.grid.UnoControlGridModel" ) oModel.Name="Grid1" oModel.GridDataModel = oDataModel oModel.ColumnModel = oColumnModel oModel.ShowColumnHeader = True oModel.ShowRowHeader = True oDialogModel.insertByName("Grid1", oModel ) </source> == Event Handling == === Supported Listeners === {| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;" |- style="background-color: #DEDEDE;" | Name || Method || Comments |- | '''XGridDataListener''' || || |- | || rowAdded || |- | || rowRemoved || Invoked after a remove row call. If removedAll was called the GridDataEvent.Index contains ''-1''. |- | || dataChanged|| |- | '''XGridColumnListener''' || || |- | || columnAdded|| |- | || columnRemoved|| |- | || columnChanged|| |- | '''XMouseListener''' || || |- | || mousePressed || |- | || mouseReleased || |- | || mouseEntered || ''Not yet implemented.'' |- | || mouseExited || ''Not yet implemented.'' |- | '''XGridSelectionListener''' || || ''Not yet implemented.'' |- | || selectionChanged || |- |} === XGridDataListener === The XGridDataListener supports methods to indicate operations on the data model of the grid control. The listener will be invoked by the data model. Each event triggered by the listener uses an instance of GridDataEvent to give details. Example: <source lang="java"> Object dataModel = xMultiComponentFactory.createInstanceWithContext( "com.sun.star.awt.grid.DefaultGridDataModel", this.context); xGridDataModel = (XGridDataModel) UnoRuntime.queryInterface( XGridDataModel.class, dataModel); xGridDataModel.addDataListener(new XGridDataListener() { public void rowAdded(GridDataEvent arg0) { throw new UnsupportedOperationException("Not supported yet."); } public void rowRemoved(GridDataEvent arg0) { throw new UnsupportedOperationException("Not supported yet."); } public void dataChanged(GridDataEvent arg0) { throw new UnsupportedOperationException("Not supported yet."); } public void disposing(EventObject arg0) { throw new UnsupportedOperationException("Not supported yet."); } }); </source> === XGridColumnLisener === The XGridColumnLisener supports methods to indicate operations on the column model of the grid control. The listener will be invoked by the column model. Each event triggered by the listener uses an instance of GridColumnEvent to give details. Example: <source lang="java"> Object columnModel = this.m_factory.createInstanceWithContext( "com.sun.star.awt.grid.DefaultGridColumnModel", this.context); XGridColumnModel xGridColumnModel = (XGridColumnModel) UnoRuntime.queryInterface( XGridColumnModel.class, columnModel); xGridColumnModel.addColumnListener(new XGridColumnListener() { public void columnAdded(GridColumnEvent arg0) { throw new UnsupportedOperationException("Not supported yet."); } public void columnRemoved(GridColumnEvent arg0) { throw new UnsupportedOperationException("Not supported yet."); } public void columnChanged(GridColumnEvent arg0) { throw new UnsupportedOperationException("Not supported yet."); } }); </source> === XMouseListener === The XMouseListener is currently not full implemented within the grid control. Only the methods ''mousePressed'' and ''mouseRelease'' are supported. Use this listener to process mouse events e.g mouse clicks on a row. Example: <source lang="java"> XControlContainer xControlCont = (XControlContainer) UnoRuntime.queryInterface( XControlContainer.class, dialog); Object objectGrid = xControlCont.getControl("Grid1"); XGridControl xGridControl = (XGridControl) UnoRuntime.queryInterface(XGridControl.class, objectGrid); XWindow xWindow = (XWindow) UnoRuntime.queryInterface(XWindow.class, objectGrid); xWindow.addMouseListener(new XMouseListener() { public void mousePressed(MouseEvent arg0) { throw new UnsupportedOperationException("Not supported yet."); } public void mouseReleased(MouseEvent arg0) { if (arg0.ClickCount >= 2) { int pos = xGridControl.getItemIndexAtPoint(arg0.X, arg0.Y); // put custom source code here. } } public void mouseEntered(MouseEvent arg0) { throw new UnsupportedOperationException("Not supported yet."); } public void mouseExited(MouseEvent arg0) { throw new UnsupportedOperationException("Not supported yet."); } public void disposing(EventObject arg0) { throw new UnsupportedOperationException("Not supported yet."); } }); </source> == Known Issues == {| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;" |- style="background-color: #DEDEDE;" | Iteration || Description || Task ID || Status || Comments |- |align=center | 1 || Currently it's not possible to grain the focus with the ''TAB'' key || - || fixed || |- |align=center | 1 || If the property UnoControlGridModel ''HScroll'' is set to ''TRUE''. All data were drawn in a small rectangle in the upper left corner || - || fixed || |- |align=center | 1 || If the property UnoControlGridModel ''HScroll'' is set to ''FALSE'' and many columns were added. The office crashes if you slide with the scrollbar to the right end. || - || fixed || |- |align=center | 1 || If the property UnoControlGridModel ''SelectionModel'' is set to ''NONE''. It's still possible to navigate with the arrow keys through the grid but mouse actions were ignored. || - || fixed || |- |align=center | 1 || All selection were removed by using left or right arrow keys. Usage of left or right arrow keys shouldn't have an effect on selection || - || fixed || |- |align=center | 1 || If text content of a cell doesn't fit into the cell it's overwrites the neighbour cell || - || fixed || |} ==Feature Set== * Width for each column * Height for each row * Each cell has its own data type * Column and row header * Vertical and horizontal scrollbars * Row selection ( Single, Multi, Range ) * Auto resizing * A11y ==Planned Iteration== {| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;" |- style="background-color: #DEDEDE;" | Iteration || Due date || Status || Comment || Description || Components |- | align=center | 1 || 2009-07-31 || style="background-color: #C0FFC0;" align=center | done || || To do: * UnoControl * Selection * Textdata only * Eventhandling * Scrollbars * Scrollbar modi * Column and row headers || * UNO ** IDL ** Impl. *VCL ** Impl. |- | align=center | 2 || 2009-11-16 || style="background-color: #C0FFC0;" align=center | done || || To do: * A11y || * UNO ** IDL ** Impl. *VCL ** Impl. |- | align=center | 3 || 2010-04-30 || style="background-color: #FFFF00;" align=center | ready for QA || || To do: * modify column and row size * exception handling * Different data types * A11y * Background, align, text settings || * UNO ** IDL ** Impl. *VCL ** Impl. |- | align=center |4 || || style="background-color: #FFFF00;" align=center | open|| || To do: * Auto resizing * Eventhandling * A11y || * UNO ** IDL ** Impl. *VCL ** Impl. |- | align=center | 5 || || style="background-color: #FFFF00;" align=center | open|| || To do: * Basic IDE * Docs/Wiki | | * IDE ** Import/Export **UI * Doc **Wiki **SDK-Examples |} ==Grid specification== === Key And Mouse Usage === {| cellpadding=5 cellspacing=0 border=1 style="border-collapse:collapse;" |- style="background-color: #DEDEDE;" | Action || Selection Modus || Description |- |align=center | '''Selection possibilities with the mouse''' || || |- |align=center | Mouse click in a cell || SINGLE / RANGE / MULTI || Single row selection. |- |align=center | Ctrl + mouse click in a cell || MULTI || Multiple rows selection possible, if row has been already selected, deselects it. |- |align=center | Shift + mouse click in a cell || RANGE / MULTI || Multiple rows selection, range is between current row and the chosen one. |- |align=center | '''Selection possibilities with the keyboard''' || || |- |align=center | Ctrl + Alt || SINGLE / RANGE / MULTI || Single row selection, if row has been already selected, deselects it. |- |align=center | Shift + UP || RANGE / MULTI ||Multiple rows selection above current row, if rows above the current one have been already selected, they can be deselected one by one. |- |align=center | Shift + DOWN || RANGE / MULTI || Multiple rows selection beneath current row, if rows beneath the current one have been already selected, they can be deselected one by one |- |align=center | Shift + HOME || RANGE / MULTI || Multiple row selection, range is between current row and top one. |- |align=center | Shift + END || RANGE / MULTI || Multiple row selection, range is between current row and bottom one . |} * Resizing [[Category:API]] [[Category:UNO AWT]]

Return to API/UNO AWT/Grid Control.