Apache OpenOffice Wiki - User contributions [en]

API/UNO AWT/Grid Control

2010-04-30T13:45:46Z

Misheto: /* Known Issues */

{{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:'''

In milestone 3 there are some new features regarding columns. Now it is possible to set width for column, horizontal alignment for the content and define whether a column should be resizeable(default value is true).

''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");
column1.setColumnWidth(15);
column1.setHorizontalAlign(com.sun.star.style.HorizontalAlignment.LEFT);
//this column shouldn't be resizeable
column1.setResizeable(false);

// #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");
column2.setColumnWidth(10);
column2.setHorizontalAlign(com.sun.star.style.HorizontalAlignment.RIGHT);
</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:'''

In milestone 3 a new method - XGridColumn copyColumn(XGridColumn xColumn) - was added. It's a convient way to define more columns, which are copies of existing ones. See example:

''Java''
<source lang="java">
Object columnModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridColumnModel", m_xContext);
XGridColumnModel xGridColumnModel = (XGridColumnModel) UnoRuntime.queryInterface(
XGridColumnModel.class, columnModel);
//xColumn3 will be the same as colum1:with same title, width, alignment and not resizable
XGridColumn xColumn3 = xGridColumnModel.copyColumn(column1);
//set new title
xColumn3.setTitle("Column3");
xGridColumnModel.addColumn(column1);
xGridColumnModel.addColumn(column2);
xGridColumnModel.addColumn(column3);
</source>
''Basic''
<source lang="oobas">
oColumnModel.addColumn( oColumn1 )
oColumnModel.addColumn( oColumn2 )
</source>

'''Use the data model of the grid control to add rows:'''

The main change in milestone 3 regarding DataModel is the possibility to add not only text but also images. That's why addRow-method has as second parameter no more string array but object array. Futher supported types are int, double, float.

''Java''
<source lang="java">
Object dataModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridDataModel", m_xContext);
XGridDataModel xGridDataModel = (XGridDataModel) UnoRuntime.queryInterface(
XGridDataModel.class, dataModel);
Object oGraphicProvider = xMultiComponentFactory.createInstanceWithContext("com.sun.star.graphic.GraphicProvider", m_xContext);
XGraphicProvider xGraphicProvider = (XGraphicProvider) UnoRuntime.queryInterface(XGraphicProvider.class, oGraphicProvider);
// create the graphic object
PropertyValue[] aPropertyValues = new PropertyValue[1];
PropertyValue aPropertyValue = new PropertyValue();
aPropertyValue.Name = "URL";
aPropertyValue.Value = "file:///c:/myimages/testimage.png";
aPropertyValues[0] = aPropertyValue;
XGraphic xGraphic = xGraphicProvider.queryGraphic(aPropertyValues);
xGridDataModel.addRow("1", new Object[]{xGraphic, "1,2", 1.3});
//one row which contains only text
xGridDataModel.addRow("2", new Object[] {"2,1","2,2", "1,3"} );
</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:'''

There are some new features regarding background, text, header and line color coming with milestone 3. So it's possible to have e.g. green headers, blue background color and red text. Default value for background color is white and for header color is grey. Default value for line color is the color of background, so the lines aren't visible. Default text color is black. There is also the possibility to set a second color for background(use property "EvenRowBackgroundColor") so that the rows will have alternating colors.

''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);
//features coming with integration of milestone 3
xPSetButton.setPropertyValue("LineColor", 0x000000); //black lines
xPSetButton.setPropertyValue("HeaderBackgroundColor", 0x00AA00);//green headers
xPSetButton.setPropertyValue("RowBackgroundColor", 0x0000CC);//blue odd rows
xPSetButton.setPropertyValue("EvenRowBackgroundColor", 0x00CC00);//green even rows
//vertical alignemnet is for all cells the same
xPSetButton.setPropertyValue("VerticalAlign", com.sun.star.style.VerticalAlignment.BOTTOM);
xPSetButton.setPropertyValue("TextColor", 0xAA0000);//red text
//for gaining the focus on TAB key stroke
xPSetButton.setPropertyValue("Tabstop", true);
</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>

'''XGridControl methods'''

In milestone 3 some new methods for handling selections are introduced. For more information please visit:

http://api.openoffice.org/docs/common/ref/com/sun/star/awt/grid/XGridControl.html

(Note: The wiki page will be updated after the milestone is integrated).

It's also possible to set a tooltip using setToolTip(String[] text, int[] cols). The first parameter shows some fixed text, which can be e.g. some information about the content of the column. If you don't want to use it, leave the array empty. The second parameter is the array containing the column numbers, which content should be shown in the tooltip. If both parameters are empty arrays, then the tooltip will contain the text of the cell where the mouse cursor currently is.

''Java''
<source lang="java">
//sets tooltip with output:
//content col1: <cont1>
//content col2: <cont2>
xGrid.setToolTip(new String{"content col1: ", "content col2: "}, new int{0, 1});
</source>

<source lang="java">
//sets tooltip with output:
//<cont1>
//<cont2>
xGrid.setToolTip(new String{}, new int{0, 1});
</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''' || ||
|-
| || columnChanged||
|-
|-
| '''XGridSelectionListener''' ||
|-
| || 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>

=== XGridColumnListener ===
The XGridColumnListener supports methods to indicate operations on the columns of the grid control. The listener will be invoked by the column.
Each event triggered by the listener uses an instance of GridColumnEvent to give details.

Example:

<source lang="java">
Object column = this.m_factory.createInstanceWithContext(
"com.sun.star.awt.grid.GridColumn", this.context);
XGridColumn xGridColumn = (XGridColumn) UnoRuntime.queryInterface( XGridColumn.class, column);

xGridColumn.addColumnListener(new XGridColumnListener() {
public void columnChanged(GridColumnEvent 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 || 110517 || fixed in m3 ||
|-
|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 || 110518 || fixed in m3 ||
|-
|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. || 110492 || fixed in m3||
|-
|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. || 110521 || fixed in m3 ||
|-
|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 || 110519 || fixed in m3||
|-
|align=center | 1 || If text content of a cell doesn't fit into the cell it's overwrites the neighbour cell || 110520 || fixed in m3 ||
|}

==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]]

API/UNO AWT/Grid Control

2010-04-30T13:44:11Z

Misheto: /* Example */

{{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:'''

In milestone 3 there are some new features regarding columns. Now it is possible to set width for column, horizontal alignment for the content and define whether a column should be resizeable(default value is true).

''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");
column1.setColumnWidth(15);
column1.setHorizontalAlign(com.sun.star.style.HorizontalAlignment.LEFT);
//this column shouldn't be resizeable
column1.setResizeable(false);

// #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");
column2.setColumnWidth(10);
column2.setHorizontalAlign(com.sun.star.style.HorizontalAlignment.RIGHT);
</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:'''

In milestone 3 a new method - XGridColumn copyColumn(XGridColumn xColumn) - was added. It's a convient way to define more columns, which are copies of existing ones. See example:

''Java''
<source lang="java">
Object columnModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridColumnModel", m_xContext);
XGridColumnModel xGridColumnModel = (XGridColumnModel) UnoRuntime.queryInterface(
XGridColumnModel.class, columnModel);
//xColumn3 will be the same as colum1:with same title, width, alignment and not resizable
XGridColumn xColumn3 = xGridColumnModel.copyColumn(column1);
//set new title
xColumn3.setTitle("Column3");
xGridColumnModel.addColumn(column1);
xGridColumnModel.addColumn(column2);
xGridColumnModel.addColumn(column3);
</source>
''Basic''
<source lang="oobas">
oColumnModel.addColumn( oColumn1 )
oColumnModel.addColumn( oColumn2 )
</source>

'''Use the data model of the grid control to add rows:'''

The main change in milestone 3 regarding DataModel is the possibility to add not only text but also images. That's why addRow-method has as second parameter no more string array but object array. Futher supported types are int, double, float.

''Java''
<source lang="java">
Object dataModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridDataModel", m_xContext);
XGridDataModel xGridDataModel = (XGridDataModel) UnoRuntime.queryInterface(
XGridDataModel.class, dataModel);
Object oGraphicProvider = xMultiComponentFactory.createInstanceWithContext("com.sun.star.graphic.GraphicProvider", m_xContext);
XGraphicProvider xGraphicProvider = (XGraphicProvider) UnoRuntime.queryInterface(XGraphicProvider.class, oGraphicProvider);
// create the graphic object
PropertyValue[] aPropertyValues = new PropertyValue[1];
PropertyValue aPropertyValue = new PropertyValue();
aPropertyValue.Name = "URL";
aPropertyValue.Value = "file:///c:/myimages/testimage.png";
aPropertyValues[0] = aPropertyValue;
XGraphic xGraphic = xGraphicProvider.queryGraphic(aPropertyValues);
xGridDataModel.addRow("1", new Object[]{xGraphic, "1,2", 1.3});
//one row which contains only text
xGridDataModel.addRow("2", new Object[] {"2,1","2,2", "1,3"} );
</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:'''

There are some new features regarding background, text, header and line color coming with milestone 3. So it's possible to have e.g. green headers, blue background color and red text. Default value for background color is white and for header color is grey. Default value for line color is the color of background, so the lines aren't visible. Default text color is black. There is also the possibility to set a second color for background(use property "EvenRowBackgroundColor") so that the rows will have alternating colors.

''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);
//features coming with integration of milestone 3
xPSetButton.setPropertyValue("LineColor", 0x000000); //black lines
xPSetButton.setPropertyValue("HeaderBackgroundColor", 0x00AA00);//green headers
xPSetButton.setPropertyValue("RowBackgroundColor", 0x0000CC);//blue odd rows
xPSetButton.setPropertyValue("EvenRowBackgroundColor", 0x00CC00);//green even rows
//vertical alignemnet is for all cells the same
xPSetButton.setPropertyValue("VerticalAlign", com.sun.star.style.VerticalAlignment.BOTTOM);
xPSetButton.setPropertyValue("TextColor", 0xAA0000);//red text
//for gaining the focus on TAB key stroke
xPSetButton.setPropertyValue("Tabstop", true);
</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>

'''XGridControl methods'''

In milestone 3 some new methods for handling selections are introduced. For more information please visit:

http://api.openoffice.org/docs/common/ref/com/sun/star/awt/grid/XGridControl.html

(Note: The wiki page will be updated after the milestone is integrated).

It's also possible to set a tooltip using setToolTip(String[] text, int[] cols). The first parameter shows some fixed text, which can be e.g. some information about the content of the column. If you don't want to use it, leave the array empty. The second parameter is the array containing the column numbers, which content should be shown in the tooltip. If both parameters are empty arrays, then the tooltip will contain the text of the cell where the mouse cursor currently is.

''Java''
<source lang="java">
//sets tooltip with output:
//content col1: <cont1>
//content col2: <cont2>
xGrid.setToolTip(new String{"content col1: ", "content col2: "}, new int{0, 1});
</source>

<source lang="java">
//sets tooltip with output:
//<cont1>
//<cont2>
xGrid.setToolTip(new String{}, new int{0, 1});
</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''' || ||
|-
| || columnChanged||
|-
|-
| '''XGridSelectionListener''' ||
|-
| || 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>

=== XGridColumnListener ===
The XGridColumnListener supports methods to indicate operations on the columns of the grid control. The listener will be invoked by the column.
Each event triggered by the listener uses an instance of GridColumnEvent to give details.

Example:

<source lang="java">
Object column = this.m_factory.createInstanceWithContext(
"com.sun.star.awt.grid.GridColumn", this.context);
XGridColumn xGridColumn = (XGridColumn) UnoRuntime.queryInterface( XGridColumn.class, column);

xGridColumn.addColumnListener(new XGridColumnListener() {
public void columnChanged(GridColumnEvent 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 || 110517 || fixed in m3 ||
|-
|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 || 110518 || fixed in m3 ||
|-
|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. || 110492 || fixed in m3||
|-
|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. || 110521 || not yet 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 || 110519 || fixed in m3||
|-
|align=center | 1 || If text content of a cell doesn't fit into the cell it's overwrites the neighbour cell || 110520 || fixed in m3 ||
|}

==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]]

API/UNO AWT/Grid Control

2010-03-31T12:12:37Z

Misheto: /* Known Issues */

{{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:'''

In milestone 3 there are some new features regarding columns. Now it is possible to set width for column, horizontal alignment for the content and define whether a column should be resizeable(default value is true).

''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");
column1.setColumnWidth(15);
column1.setHorizontalAlign(com.sun.star.style.HorizontalAlignment.LEFT);
//this column shouldn't be resizeable
column1.setResizeable(false);

// #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");
column2.setColumnWidth(10);
column2.setHorizontalAlign(com.sun.star.style.HorizontalAlignment.RIGHT);
</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:'''

In milestone 3 a new method - XGridColumn copyColumn(XGridColumn xColumn) - was added. It's a convient way to define more columns, which are copies of existing ones. See example:

''Java''
<source lang="java">
Object columnModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridColumnModel", m_xContext);
XGridColumnModel xGridColumnModel = (XGridColumnModel) UnoRuntime.queryInterface(
XGridColumnModel.class, columnModel);
//xColumn3 will be the same as colum1:with same title, width, alignment and not resizable
XGridColumn xColumn3 = xGridColumnModel.copyColumn(column1);
//set new title
xColumn3.setTitle("Column3");
xGridColumnModel.addColumn(column1);
xGridColumnModel.addColumn(column2);
xGridColumnModel.addColumn(column3);
</source>
''Basic''
<source lang="oobas">
oColumnModel.addColumn( oColumn1 )
oColumnModel.addColumn( oColumn2 )
</source>

'''Use the data model of the grid control to add rows:'''

The main change in milestone 3 regarding DataModel is the possibility to add not only text but also images. That's why addRow-method has as second parameter no more string array but object array. Futher supported types are int, double, float.

''Java''
<source lang="java">
Object dataModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridDataModel", m_xContext);
XGridDataModel xGridDataModel = (XGridDataModel) UnoRuntime.queryInterface(
XGridDataModel.class, dataModel);
Object oGraphicProvider = xMultiComponentFactory.createInstanceWithContext("com.sun.star.graphic.GraphicProvider", m_xContext);
XGraphicProvider xGraphicProvider = (XGraphicProvider) UnoRuntime.queryInterface(XGraphicProvider.class, oGraphicProvider);
// create the graphic object
PropertyValue[] aPropertyValues = new PropertyValue[1];
PropertyValue aPropertyValue = new PropertyValue();
aPropertyValue.Name = "URL";
aPropertyValue.Value = "file:///c:/myimages/testimage.png";
aPropertyValues[0] = aPropertyValue;
XGraphic xGraphic = xGraphicProvider.queryGraphic(aPropertyValues);
xGridDataModel.addRow("1", new Object[]{xGraphic, "1,2", 1.3});
//one row which contains only text
xGridDataModel.addRow("2", new Object[] {"2,1","2,2", "1,3"} );
</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:'''

There are some new features regarding background, text, header and line color coming with milestone 3. So it's possible to have e.g. grey headers, blue background color and red text. Default value for background and header color is white. Default value for line color is the color of background, so the lines aren't visible. Default text color is black. There is also the possibility to set a second color for background(use property "EvenRowBackgroundColor") so that the rows will have alternating colors.

''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);
//features coming with integration of milestone 3
xPSetButton.setPropertyValue("LineColor", 0x000000); //black lines
xPSetButton.setPropertyValue("HeaderBackgroundColor", 0xCCCCCC);//grey headers
xPSetButton.setPropertyValue("RowBackgroundColor", 0x0000CC);//blue odd rows
xPSetButton.setPropertyValue("EvenRowBackgroundColor", 0x00CC00);//green even rows
//vertical alignemnet is for all cells the same
xPSetButton.setPropertyValue("VerticalAlign", com.sun.star.style.VerticalAlignment.BOTTOM);
xPSetButton.setPropertyValue("TextColor", 0xAA0000);//red text
//for gaining the focus on TAB key stroke
xPSetButton.setPropertyValue("Tabstop", true);
</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>

'''XGridControl methods'''

In milestone 3 some new methods for handling selections are introduced. For more information please visit:

http://api.openoffice.org/docs/common/ref/com/sun/star/awt/grid/XGridControl.html

(Note: The wiki page will be updated after the milestone is integrated).

It's also possible to set a tooltip using setToolTip(String[] text, int[] cols). The first parameter shows some fixed text, which can be e.g. some information about the content of the column. If you don't want to use it, leave the array empty. The second parameter is the array containing the column numbers, which content should be shown in the tooltip.

''Java''
<source lang="java">
//sets tooltip with output:
//content col1: <cont1>
//content col2: <cont2>
xGrid.setToolTip(new String{"content col1: ", "content col2: "}, new int{0, 1});
</source>

<source lang="java">
//sets tooltip with output:
//<cont1>
//<cont2>
xGrid.setToolTip(new String{}, new int{0, 1});
</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''' || ||
|-
| || columnChanged||
|-
|-
| '''XGridSelectionListener''' ||
|-
| || 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>

=== XGridColumnListener ===
The XGridColumnListener supports methods to indicate operations on the columns of the grid control. The listener will be invoked by the column.
Each event triggered by the listener uses an instance of GridColumnEvent to give details.

Example:

<source lang="java">
Object column = this.m_factory.createInstanceWithContext(
"com.sun.star.awt.grid.GridColumn", this.context);
XGridColumn xGridColumn = (XGridColumn) UnoRuntime.queryInterface( XGridColumn.class, column);

xGridColumn.addColumnListener(new XGridColumnListener() {
public void columnChanged(GridColumnEvent 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 || 110517 || fixed in m3 ||
|-
|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 || 110518 || fixed in m3 ||
|-
|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. || 110492 || fixed in m3||
|-
|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. || 110521 || not yet 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 || 110519 || fixed in m3||
|-
|align=center | 1 || If text content of a cell doesn't fit into the cell it's overwrites the neighbour cell || 110520 || fixed in m3 ||
|}

==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]]

API/UNO AWT/Grid Control

2010-03-31T10:35:57Z

Misheto: /* Example */

{{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:'''

In milestone 3 there are some new features regarding columns. Now it is possible to set width for column, horizontal alignment for the content and define whether a column should be resizeable(default value is true).

''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");
column1.setColumnWidth(15);
column1.setHorizontalAlign(com.sun.star.style.HorizontalAlignment.LEFT);
//this column shouldn't be resizeable
column1.setResizeable(false);

// #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");
column2.setColumnWidth(10);
column2.setHorizontalAlign(com.sun.star.style.HorizontalAlignment.RIGHT);
</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:'''

In milestone 3 a new method - XGridColumn copyColumn(XGridColumn xColumn) - was added. It's a convient way to define more columns, which are copies of existing ones. See example:

''Java''
<source lang="java">
Object columnModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridColumnModel", m_xContext);
XGridColumnModel xGridColumnModel = (XGridColumnModel) UnoRuntime.queryInterface(
XGridColumnModel.class, columnModel);
//xColumn3 will be the same as colum1:with same title, width, alignment and not resizable
XGridColumn xColumn3 = xGridColumnModel.copyColumn(column1);
//set new title
xColumn3.setTitle("Column3");
xGridColumnModel.addColumn(column1);
xGridColumnModel.addColumn(column2);
xGridColumnModel.addColumn(column3);
</source>
''Basic''
<source lang="oobas">
oColumnModel.addColumn( oColumn1 )
oColumnModel.addColumn( oColumn2 )
</source>

'''Use the data model of the grid control to add rows:'''

The main change in milestone 3 regarding DataModel is the possibility to add not only text but also images. That's why addRow-method has as second parameter no more string array but object array. Futher supported types are int, double, float.

''Java''
<source lang="java">
Object dataModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridDataModel", m_xContext);
XGridDataModel xGridDataModel = (XGridDataModel) UnoRuntime.queryInterface(
XGridDataModel.class, dataModel);
Object oGraphicProvider = xMultiComponentFactory.createInstanceWithContext("com.sun.star.graphic.GraphicProvider", m_xContext);
XGraphicProvider xGraphicProvider = (XGraphicProvider) UnoRuntime.queryInterface(XGraphicProvider.class, oGraphicProvider);
// create the graphic object
PropertyValue[] aPropertyValues = new PropertyValue[1];
PropertyValue aPropertyValue = new PropertyValue();
aPropertyValue.Name = "URL";
aPropertyValue.Value = "file:///c:/myimages/testimage.png";
aPropertyValues[0] = aPropertyValue;
XGraphic xGraphic = xGraphicProvider.queryGraphic(aPropertyValues);
xGridDataModel.addRow("1", new Object[]{xGraphic, "1,2", 1.3});
//one row which contains only text
xGridDataModel.addRow("2", new Object[] {"2,1","2,2", "1,3"} );
</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:'''

There are some new features regarding background, text, header and line color coming with milestone 3. So it's possible to have e.g. grey headers, blue background color and red text. Default value for background and header color is white. Default value for line color is the color of background, so the lines aren't visible. Default text color is black. There is also the possibility to set a second color for background(use property "EvenRowBackgroundColor") so that the rows will have alternating colors.

''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);
//features coming with integration of milestone 3
xPSetButton.setPropertyValue("LineColor", 0x000000); //black lines
xPSetButton.setPropertyValue("HeaderBackgroundColor", 0xCCCCCC);//grey headers
xPSetButton.setPropertyValue("RowBackgroundColor", 0x0000CC);//blue odd rows
xPSetButton.setPropertyValue("EvenRowBackgroundColor", 0x00CC00);//green even rows
//vertical alignemnet is for all cells the same
xPSetButton.setPropertyValue("VerticalAlign", com.sun.star.style.VerticalAlignment.BOTTOM);
xPSetButton.setPropertyValue("TextColor", 0xAA0000);//red text
//for gaining the focus on TAB key stroke
xPSetButton.setPropertyValue("Tabstop", true);
</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>

'''XGridControl methods'''

In milestone 3 some new methods for handling selections are introduced. For more information please visit:

http://api.openoffice.org/docs/common/ref/com/sun/star/awt/grid/XGridControl.html

(Note: The wiki page will be updated after the milestone is integrated).

It's also possible to set a tooltip using setToolTip(String[] text, int[] cols). The first parameter shows some fixed text, which can be e.g. some information about the content of the column. If you don't want to use it, leave the array empty. The second parameter is the array containing the column numbers, which content should be shown in the tooltip.

''Java''
<source lang="java">
//sets tooltip with output:
//content col1: <cont1>
//content col2: <cont2>
xGrid.setToolTip(new String{"content col1: ", "content col2: "}, new int{0, 1});
</source>

<source lang="java">
//sets tooltip with output:
//<cont1>
//<cont2>
xGrid.setToolTip(new String{}, new int{0, 1});
</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''' || ||
|-
| || columnChanged||
|-
|-
| '''XGridSelectionListener''' ||
|-
| || 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>

=== XGridColumnListener ===
The XGridColumnListener supports methods to indicate operations on the columns of the grid control. The listener will be invoked by the column.
Each event triggered by the listener uses an instance of GridColumnEvent to give details.

Example:

<source lang="java">
Object column = this.m_factory.createInstanceWithContext(
"com.sun.star.awt.grid.GridColumn", this.context);
XGridColumn xGridColumn = (XGridColumn) UnoRuntime.queryInterface( XGridColumn.class, column);

xGridColumn.addColumnListener(new XGridColumnListener() {
public void columnChanged(GridColumnEvent 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 in m3 ||
|-
|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 in m3 ||
|-
|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 in m3||
|-
|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. || - || not yet 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 in m3||
|-
|align=center | 1 || If text content of a cell doesn't fit into the cell it's overwrites the neighbour cell || - || fixed in m3 ||
|}

==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]]

API/UNO AWT/Grid Control

2010-03-31T09:47:27Z

Misheto: /* Example */

{{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:'''

In milestone 3 there are some new features regarding columns. Now it is possible to set width for column, horizontal alignment for the content and define whether a column should be resizeable(default value is true).

''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");
column1.setColumnWidth(15);
column1.setHorizontalAlign(com.sun.star.style.HorizontalAlignment.LEFT);
//this column shouldn't be resizeable
column1.setResizeable(false);

// #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");
column2.setColumnWidth(10);
column2.setHorizontalAlign(com.sun.star.style.HorizontalAlignment.RIGHT);
</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:'''

In milestone 3 a new method - XGridColumn copyColumn(XGridColumn xColumn) - was added. It's a convient way to define more columns, which are copies of existing ones. See example:

''Java''
<source lang="java">
Object columnModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridColumnModel", m_xContext);
XGridColumnModel xGridColumnModel = (XGridColumnModel) UnoRuntime.queryInterface(
XGridColumnModel.class, columnModel);
//xColumn3 will be the same as colum1:with same title, width, alignment and not resizable
XGridColumn xColumn3 = xGridColumnModel.copyColumn(column1);
//set new title
xColumn3.setTitle("Column3");
xGridColumnModel.addColumn(column1);
xGridColumnModel.addColumn(column2);
xGridColumnModel.addColumn(column3);
</source>
''Basic''
<source lang="oobas">
oColumnModel.addColumn( oColumn1 )
oColumnModel.addColumn( oColumn2 )
</source>

'''Use the data model of the grid control to add rows:'''

The main change in milestone 3 regarding DataModel is the possibility to add not only text but also images. That's why addRow-method has as second parameter no more string array but object array. Futher supported types are int, double, float.

''Java''
<source lang="java">
Object dataModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridDataModel", m_xContext);
XGridDataModel xGridDataModel = (XGridDataModel) UnoRuntime.queryInterface(
XGridDataModel.class, dataModel);
Object oGraphicProvider = xMultiComponentFactory.createInstanceWithContext("com.sun.star.graphic.GraphicProvider", m_xContext);
XGraphicProvider xGraphicProvider = (XGraphicProvider) UnoRuntime.queryInterface(XGraphicProvider.class, oGraphicProvider);
// create the graphic object
PropertyValue[] aPropertyValues = new PropertyValue[1];
PropertyValue aPropertyValue = new PropertyValue();
aPropertyValue.Name = "URL";
aPropertyValue.Value = "file:///c:/myimages/testimage.png";
aPropertyValues[0] = aPropertyValue;
XGraphic xGraphic = xGraphicProvider.queryGraphic(aPropertyValues);
xGridDataModel.addRow("1", new Object[]{xGraphic, "1,2", 1.3});
//one row which contains only text
xGridDataModel.addRow("2", new Object[] {"2,1","2,2", "1,3"} );
</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:'''

There are some new features regarding background, text, header and line color coming with milestone 3. So it's possible to have e.g. grey headers, blue background color and red text. Default value for background and header color is white. Default value for line color is the color of background, so the lines aren't visible. Default text color is black. There is also the possibility to set a second color for background(use property "EvenRowBackgroundColor") so that the rows will have alternating colors.

''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);
//features coming with integration of milestone 3
xPSetButton.setPropertyValue("LineColor", 0x000000); //black lines
xPSetButton.setPropertyValue("HeaderBackgroundColor", 0xCCCCCC);//grey headers
xPSetButton.setPropertyValue("RowBackgroundColor", 0x0000CC);//blue odd rows
xPSetButton.setPropertyValue("EvenRowBackgroundColor", 0x00CC00);//green even rows
//vertical alignemnet is for all cells the same
xPSetButton.setPropertyValue("VerticalAlign", com.sun.star.style.VerticalAlignment.BOTTOM);
xPSetButton.setPropertyValue("TextColor", 0xAA0000);//red text
//for gaining the focus on TAB key stroke
xPSetButton.setPropertyValue("Tabstop", true);
</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>

'''XGridControl methods'''

In milestone 3 some new methods for handling selections are introduced. For more information please visit:

http://api.openoffice.org/docs/common/ref/com/sun/star/awt/grid/XGridControl.html

(Note: The wiki page will be updated after the milestone is integrated).

It's also possible to set a tooltip using setTooltip(String[] text, int[] cols). The first parameter shows some fixed text, which can be e.g. some information about the content of the column. If you don't want to use it, leave the array empty. The second parameter is the array containing the column numbers, which content should be shown in the tooltip.

''Java''
<source lang="java">
//sets tooltip with output:
//content col1: <cont1>
//content col2: <cont2>
xGrid.setTooltip(new String{"content col1: ", "content col2: "}, new int{0, 1});
</source>

<source lang="java">
//sets tooltip with output:
//<cont1>
//<cont2>
xGrid.setTooltip(new String{""}, new int{0, 1});
</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''' || ||
|-
| || columnChanged||
|-
|-
| '''XGridSelectionListener''' ||
|-
| || 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>

=== XGridColumnListener ===
The XGridColumnListener supports methods to indicate operations on the columns of the grid control. The listener will be invoked by the column.
Each event triggered by the listener uses an instance of GridColumnEvent to give details.

Example:

<source lang="java">
Object column = this.m_factory.createInstanceWithContext(
"com.sun.star.awt.grid.GridColumn", this.context);
XGridColumn xGridColumn = (XGridColumn) UnoRuntime.queryInterface( XGridColumn.class, column);

xGridColumn.addColumnListener(new XGridColumnListener() {
public void columnChanged(GridColumnEvent 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 in m3 ||
|-
|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 in m3 ||
|-
|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 in m3||
|-
|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. || - || not yet 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 in m3||
|-
|align=center | 1 || If text content of a cell doesn't fit into the cell it's overwrites the neighbour cell || - || fixed in m3 ||
|}

==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]]

API/UNO AWT/Grid Control

2010-03-31T08:34:05Z

Misheto: /* XGridColumnLisener */

{{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:'''

In milestone 3 there are some new features regarding columns. Now it is possible to set width for column, horizontal alignment for the content and define whether a column should be resizeable(default value is true).

''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");
column1.setColumnWidth(15);
column1.setHorizontalAlign(com.sun.star.style.HorizontalAlignment.LEFT);
//this column shouldn't be resizeable
column1.setResizeable(false);

// #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");
column2.setColumnWidth(10);
column2.setHorizontalAlign(com.sun.star.style.HorizontalAlignment.RIGHT);
</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:'''

In milestone 3 a new method - XGridColumn copyColumn(XGridColumn xColumn) - was added. It's a convient way to define more columns, which are copies of existing ones. See example:

''Java''
<source lang="java">
Object columnModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridColumnModel", m_xContext);
XGridColumnModel xGridColumnModel = (XGridColumnModel) UnoRuntime.queryInterface(
XGridColumnModel.class, columnModel);
//xColumn3 will be the same as colum1:with same title, width, alignment and not resizable
XGridColumn xColumn3 = xGridColumnModel.copyColumn(column1);
//set new title
xColumn3.setTitle("Column3");
xGridColumnModel.addColumn(column1);
xGridColumnModel.addColumn(column2);
xGridColumnModel.addColumn(column3);
</source>
''Basic''
<source lang="oobas">
oColumnModel.addColumn( oColumn1 )
oColumnModel.addColumn( oColumn2 )
</source>

'''Use the data model of the grid control to add rows:'''

The main change in milestone 3 regarding DataModel is the possibility to add not only text but also images. That's why addRow-method has as second parameter no more string array but object array. Futher supported types are int, double, float.

''Java''
<source lang="java">
Object dataModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridDataModel", m_xContext);
XGridDataModel xGridDataModel = (XGridDataModel) UnoRuntime.queryInterface(
XGridDataModel.class, dataModel);
Object oGraphicProvider = xMultiComponentFactory.createInstanceWithContext("com.sun.star.graphic.GraphicProvider", m_xContext);
XGraphicProvider xGraphicProvider = (XGraphicProvider) UnoRuntime.queryInterface(XGraphicProvider.class, oGraphicProvider);
// create the graphic object
PropertyValue[] aPropertyValues = new PropertyValue[1];
PropertyValue aPropertyValue = new PropertyValue();
aPropertyValue.Name = "URL";
aPropertyValue.Value = "file:///c:/myimages/testimage.png";
aPropertyValues[0] = aPropertyValue;
XGraphic xGraphic = xGraphicProvider.queryGraphic(aPropertyValues);
xGridDataModel.addRow("1", new Object[]{xGraphic, "1,2", 1.3});
//one row which contains only text
xGridDataModel.addRow("2", new Object[] {"2,1","2,2", "1,3"} );
</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:'''

There are some new features regarding background, text, header and line color coming with milestone 3. So it's possible to have e.g. grey headers, blue background color and red text. Default value for background and header color is white. Default value for line color is the color of background, so the lines aren't visible. Default text color is black. There is also the possibility to set a second color for background(use property "EvenRowBackgroundColor") so that the rows will have alternating colors.

''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);
//features coming with integration of milestone 3
xPSetButton.setPropertyValue("LineColor", 0x000000); //black lines
xPSetButton.setPropertyValue("HeaderBackgroundColor", 0xCCCCCC);//grey headers
xPSetButton.setPropertyValue("RowBackgroundColor", 0x0000CC);//blue odd rows
xPSetButton.setPropertyValue("EvenRowBackgroundColor", 0x00CC00);//green even rows
//vertical alignemnet is for all cells the same
xPSetButton.setPropertyValue("VerticalAlign", com.sun.star.style.VerticalAlignment.BOTTOM);
xPSetButton.setPropertyValue("TextColor", 0xAA0000);//red text
//for gaining the focus on TAB key stroke
xPSetButton.setPropertyValue("Tabstop", true);
</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''' || ||
|-
| || columnChanged||
|-
|-
| '''XGridSelectionListener''' ||
|-
| || 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>

=== XGridColumnListener ===
The XGridColumnListener supports methods to indicate operations on the columns of the grid control. The listener will be invoked by the column.
Each event triggered by the listener uses an instance of GridColumnEvent to give details.

Example:

<source lang="java">
Object column = this.m_factory.createInstanceWithContext(
"com.sun.star.awt.grid.GridColumn", this.context);
XGridColumn xGridColumn = (XGridColumn) UnoRuntime.queryInterface( XGridColumn.class, column);

xGridColumn.addColumnListener(new XGridColumnListener() {
public void columnChanged(GridColumnEvent 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 in m3 ||
|-
|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 in m3 ||
|-
|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 in m3||
|-
|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. || - || not yet 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 in m3||
|-
|align=center | 1 || If text content of a cell doesn't fit into the cell it's overwrites the neighbour cell || - || fixed in m3 ||
|}

==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]]

API/UNO AWT/Grid Control

2010-03-31T08:22:00Z

Misheto: /* Known Issues */

{{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:'''

In milestone 3 there are some new features regarding columns. Now it is possible to set width for column, horizontal alignment for the content and define whether a column should be resizeable(default value is true).

''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");
column1.setColumnWidth(15);
column1.setHorizontalAlign(com.sun.star.style.HorizontalAlignment.LEFT);
//this column shouldn't be resizeable
column1.setResizeable(false);

// #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");
column2.setColumnWidth(10);
column2.setHorizontalAlign(com.sun.star.style.HorizontalAlignment.RIGHT);
</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:'''

In milestone 3 a new method - XGridColumn copyColumn(XGridColumn xColumn) - was added. It's a convient way to define more columns, which are copies of existing ones. See example:

''Java''
<source lang="java">
Object columnModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridColumnModel", m_xContext);
XGridColumnModel xGridColumnModel = (XGridColumnModel) UnoRuntime.queryInterface(
XGridColumnModel.class, columnModel);
//xColumn3 will be the same as colum1:with same title, width, alignment and not resizable
XGridColumn xColumn3 = xGridColumnModel.copyColumn(column1);
//set new title
xColumn3.setTitle("Column3");
xGridColumnModel.addColumn(column1);
xGridColumnModel.addColumn(column2);
xGridColumnModel.addColumn(column3);
</source>
''Basic''
<source lang="oobas">
oColumnModel.addColumn( oColumn1 )
oColumnModel.addColumn( oColumn2 )
</source>

'''Use the data model of the grid control to add rows:'''

The main change in milestone 3 regarding DataModel is the possibility to add not only text but also images. That's why addRow-method has as second parameter no more string array but object array. Futher supported types are int, double, float.

''Java''
<source lang="java">
Object dataModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridDataModel", m_xContext);
XGridDataModel xGridDataModel = (XGridDataModel) UnoRuntime.queryInterface(
XGridDataModel.class, dataModel);
Object oGraphicProvider = xMultiComponentFactory.createInstanceWithContext("com.sun.star.graphic.GraphicProvider", m_xContext);
XGraphicProvider xGraphicProvider = (XGraphicProvider) UnoRuntime.queryInterface(XGraphicProvider.class, oGraphicProvider);
// create the graphic object
PropertyValue[] aPropertyValues = new PropertyValue[1];
PropertyValue aPropertyValue = new PropertyValue();
aPropertyValue.Name = "URL";
aPropertyValue.Value = "file:///c:/myimages/testimage.png";
aPropertyValues[0] = aPropertyValue;
XGraphic xGraphic = xGraphicProvider.queryGraphic(aPropertyValues);
xGridDataModel.addRow("1", new Object[]{xGraphic, "1,2", 1.3});
//one row which contains only text
xGridDataModel.addRow("2", new Object[] {"2,1","2,2", "1,3"} );
</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:'''

There are some new features regarding background, text, header and line color coming with milestone 3. So it's possible to have e.g. grey headers, blue background color and red text. Default value for background and header color is white. Default value for line color is the color of background, so the lines aren't visible. Default text color is black. There is also the possibility to set a second color for background(use property "EvenRowBackgroundColor") so that the rows will have alternating colors.

''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);
//features coming with integration of milestone 3
xPSetButton.setPropertyValue("LineColor", 0x000000); //black lines
xPSetButton.setPropertyValue("HeaderBackgroundColor", 0xCCCCCC);//grey headers
xPSetButton.setPropertyValue("RowBackgroundColor", 0x0000CC);//blue odd rows
xPSetButton.setPropertyValue("EvenRowBackgroundColor", 0x00CC00);//green even rows
//vertical alignemnet is for all cells the same
xPSetButton.setPropertyValue("VerticalAlign", com.sun.star.style.VerticalAlignment.BOTTOM);
xPSetButton.setPropertyValue("TextColor", 0xAA0000);//red text
//for gaining the focus on TAB key stroke
xPSetButton.setPropertyValue("Tabstop", true);
</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''' || ||
|-
| || columnChanged||
|-
|-
| '''XGridSelectionListener''' ||
|-
| || 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 columns of the grid control. The listener will be invoked by the column.
Each event triggered by the listener uses an instance of GridColumnEvent to give details.

Example:

<source lang="java">
Object column = this.m_factory.createInstanceWithContext(
"com.sun.star.awt.grid.GridColumn", this.context);
XGridColumn xGridColumn = (XGridColumn) UnoRuntime.queryInterface( XGridColumn.class, column);

xGridColumn.addColumnListener(new XGridColumnListener() {
public void columnChanged(GridColumnEvent 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 in m3 ||
|-
|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 in m3 ||
|-
|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 in m3||
|-
|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. || - || not yet 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 in m3||
|-
|align=center | 1 || If text content of a cell doesn't fit into the cell it's overwrites the neighbour cell || - || fixed in m3 ||
|}

==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]]

API/UNO AWT/Grid Control

2010-03-30T15:58:33Z

Misheto: /* Example */

{{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:'''

In milestone 3 there are some new features regarding columns. Now it is possible to set width for column, horizontal alignment for the content and define whether a column should be resizeable(default value is true).

''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");
column1.setColumnWidth(15);
column1.setHorizontalAlign(com.sun.star.style.HorizontalAlignment.LEFT);
//this column shouldn't be resizeable
column1.setResizeable(false);

// #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");
column2.setColumnWidth(10);
column2.setHorizontalAlign(com.sun.star.style.HorizontalAlignment.RIGHT);
</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:'''

In milestone 3 a new method - XGridColumn copyColumn(XGridColumn xColumn) - was added. It's a convient way to define more columns, which are copies of existing ones. See example:

''Java''
<source lang="java">
Object columnModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridColumnModel", m_xContext);
XGridColumnModel xGridColumnModel = (XGridColumnModel) UnoRuntime.queryInterface(
XGridColumnModel.class, columnModel);
//xColumn3 will be the same as colum1:with same title, width, alignment and not resizable
XGridColumn xColumn3 = xGridColumnModel.copyColumn(column1);
//set new title
xColumn3.setTitle("Column3");
xGridColumnModel.addColumn(column1);
xGridColumnModel.addColumn(column2);
xGridColumnModel.addColumn(column3);
</source>
''Basic''
<source lang="oobas">
oColumnModel.addColumn( oColumn1 )
oColumnModel.addColumn( oColumn2 )
</source>

'''Use the data model of the grid control to add rows:'''

The main change in milestone 3 regarding DataModel is the possibility to add not only text but also images. That's why addRow-method has as second parameter no more string array but object array. Futher supported types are int, double, float.

''Java''
<source lang="java">
Object dataModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridDataModel", m_xContext);
XGridDataModel xGridDataModel = (XGridDataModel) UnoRuntime.queryInterface(
XGridDataModel.class, dataModel);
Object oGraphicProvider = xMultiComponentFactory.createInstanceWithContext("com.sun.star.graphic.GraphicProvider", m_xContext);
XGraphicProvider xGraphicProvider = (XGraphicProvider) UnoRuntime.queryInterface(XGraphicProvider.class, oGraphicProvider);
// create the graphic object
PropertyValue[] aPropertyValues = new PropertyValue[1];
PropertyValue aPropertyValue = new PropertyValue();
aPropertyValue.Name = "URL";
aPropertyValue.Value = "file:///c:/myimages/testimage.png";
aPropertyValues[0] = aPropertyValue;
XGraphic xGraphic = xGraphicProvider.queryGraphic(aPropertyValues);
xGridDataModel.addRow("1", new Object[]{xGraphic, "1,2", 1.3});
//one row which contains only text
xGridDataModel.addRow("2", new Object[] {"2,1","2,2", "1,3"} );
</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:'''

There are some new features regarding background, text, header and line color coming with milestone 3. So it's possible to have e.g. grey headers, blue background color and red text. Default value for background and header color is white. Default value for line color is the color of background, so the lines aren't visible. Default text color is black. There is also the possibility to set a second color for background(use property "EvenRowBackgroundColor") so that the rows will have alternating colors.

''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);
//features coming with integration of milestone 3
xPSetButton.setPropertyValue("LineColor", 0x000000); //black lines
xPSetButton.setPropertyValue("HeaderBackgroundColor", 0xCCCCCC);//grey headers
xPSetButton.setPropertyValue("RowBackgroundColor", 0x0000CC);//blue odd rows
xPSetButton.setPropertyValue("EvenRowBackgroundColor", 0x00CC00);//green even rows
//vertical alignemnet is for all cells the same
xPSetButton.setPropertyValue("VerticalAlign", com.sun.star.style.VerticalAlignment.BOTTOM);
xPSetButton.setPropertyValue("TextColor", 0xAA0000);//red text
//for gaining the focus on TAB key stroke
xPSetButton.setPropertyValue("Tabstop", true);
</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''' || ||
|-
| || columnChanged||
|-
|-
| '''XGridSelectionListener''' ||
|-
| || 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 columns of the grid control. The listener will be invoked by the column.
Each event triggered by the listener uses an instance of GridColumnEvent to give details.

Example:

<source lang="java">
Object column = this.m_factory.createInstanceWithContext(
"com.sun.star.awt.grid.GridColumn", this.context);
XGridColumn xGridColumn = (XGridColumn) UnoRuntime.queryInterface( XGridColumn.class, column);

xGridColumn.addColumnListener(new XGridColumnListener() {
public void columnChanged(GridColumnEvent 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. || - || not yet 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]]

API/UNO AWT/Grid Control

2010-03-30T15:39:55Z

Misheto:

{{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:'''

In milestone 3 there are some new features regarding columns. Now it is possible to set width for column, horizontal alignment for the content and define whether a column should be resizeable(default value is true).

''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");
column1.setColumnWidth(15);
column1.setHorizontalAlign(com.sun.star.style.HorizontalAlignment.LEFT);
//this column shouldn't be resizeable
column1.setResizeable(false);

// #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");
column2.setColumnWidth(10);
column2.setHorizontalAlign(com.sun.star.style.HorizontalAlignment.RIGHT);
</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:'''

In milestone 3 a new method - XGridColumn copyColumn(XGridColumn xColumn) - was added. It's a convient way to define more columns, which are copies of existing ones. See example:

''Java''
<source lang="java">
Object columnModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridColumnModel", m_xContext);
XGridColumnModel xGridColumnModel = (XGridColumnModel) UnoRuntime.queryInterface(
XGridColumnModel.class, columnModel);
//xColumn3 will be the same as colum1:with same title, width, alignment and not resizable
XGridColumn xColumn3 = xGridColumnModel.copyColumn(column1);
//set new title
xColumn3.setTitle("Column3");
xGridColumnModel.addColumn(column1);
xGridColumnModel.addColumn(column2);
xGridColumnModel.addColumn(column3);
</source>
''Basic''
<source lang="oobas">
oColumnModel.addColumn( oColumn1 )
oColumnModel.addColumn( oColumn2 )
</source>

'''Use the data model of the grid control to add rows:'''

The main change in milestone 3 regarding DataModel is the possibility to add not only text but also images. That's why addRow-method has as second parameter no more string array but object array. Futher supported types are int, double, float.

''Java''
<source lang="java">
Object dataModel = xMultiComponentFactory.createInstanceWithContext(
"com.sun.star.awt.grid.DefaultGridDataModel", m_xContext);
XGridDataModel xGridDataModel = (XGridDataModel) UnoRuntime.queryInterface(
XGridDataModel.class, dataModel);
Object oGraphicProvider = xMultiComponentFactory.createInstanceWithContext("com.sun.star.graphic.GraphicProvider", m_xContext);
XGraphicProvider xGraphicProvider = (XGraphicProvider) UnoRuntime.queryInterface(XGraphicProvider.class, oGraphicProvider);
// create the graphic object
PropertyValue[] aPropertyValues = new PropertyValue[1];
PropertyValue aPropertyValue = new PropertyValue();
aPropertyValue.Name = "URL";
aPropertyValue.Value = "file:///c:/myimages/testimage.png";
aPropertyValues[0] = aPropertyValue;
XGraphic xGraphic = xGraphicProvider.queryGraphic(aPropertyValues);
xGridDataModel.addRow("1", new Object[]{xGraphic, "1,2", 1.3});
//one row which contains only text
xGridDataModel.addRow("2", new Object[] {"2,1","2,2", "1,3"} );
</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''' || ||
|-
| || columnChanged||
|-
|-
| '''XGridSelectionListener''' ||
|-
| || 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 columns of the grid control. The listener will be invoked by the column.
Each event triggered by the listener uses an instance of GridColumnEvent to give details.

Example:

<source lang="java">
Object column = this.m_factory.createInstanceWithContext(
"com.sun.star.awt.grid.GridColumn", this.context);
XGridColumn xGridColumn = (XGridColumn) UnoRuntime.queryInterface( XGridColumn.class, column);

xGridColumn.addColumnListener(new XGridColumnListener() {
public void columnChanged(GridColumnEvent 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. || - || not yet 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]]

API/UNO AWT/Grid Control

2010-03-30T15:07:39Z

Misheto: /* Example */ (checkpoint save)

{{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:'''
In milestone 3 there are some new features regarding columns. Now it is possible to set width for column, horizontal alignment for the content and define whether a column should be resizeable(default value is true).
''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");
column1.setColumnWidth(15);
column1.setHorizontalAlign(com.sun.star.style.HorizontalAlignment.LEFT);
//this column shouldn't be resizeable
column1.setResizeable(false);

// #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");
column2.setColumnWidth(10);
column2.setHorizontalAlign(com.sun.star.style.HorizontalAlignment.RIGHT);
</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''' || ||
|-
| || columnChanged||
|-
|-
| '''XGridSelectionListener''' ||
|-
| || 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 columns of the grid control. The listener will be invoked by the column.
Each event triggered by the listener uses an instance of GridColumnEvent to give details.

Example:

<source lang="java">
Object column = this.m_factory.createInstanceWithContext(
"com.sun.star.awt.grid.GridColumn", this.context);
XGridColumn xGridColumn = (XGridColumn) UnoRuntime.queryInterface( XGridColumn.class, column);

xGridColumn.addColumnListener(new XGridColumnListener() {
public void columnChanged(GridColumnEvent 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. || - || not yet 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]]

API/UNO AWT/Grid Control

2010-03-30T14:13:47Z

Misheto: /* Event Handling */

{{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''' || ||
|-
| || columnChanged||
|-
|-
| '''XGridSelectionListener''' ||
|-
| || 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 columns of the grid control. The listener will be invoked by the column.
Each event triggered by the listener uses an instance of GridColumnEvent to give details.

Example:

<source lang="java">
Object column = this.m_factory.createInstanceWithContext(
"com.sun.star.awt.grid.GridColumn", this.context);
XGridColumn xGridColumn = (XGridColumn) UnoRuntime.queryInterface( XGridColumn.class, column);

xGridColumn.addColumnListener(new XGridColumnListener() {
public void columnChanged(GridColumnEvent 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. || - || not yet 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]]

API/UNO AWT/Grid Control

2010-03-30T14:06:12Z

Misheto: /* Known Issues */

{{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. || - || not yet 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]]

API/UNO AWT/Grid Control

2010-03-30T14:05:50Z

Misheto: /* Known Issues */

{{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]]

API/UNO AWT/Grid Control

2010-03-30T13:55:34Z

Misheto: /* Planned Iteration */

{{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 || - || new ||
|-
|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 || - || new ||
|-
|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 || - || new ||
|}

==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]]

DomainDeveloper

2009-12-14T15:07:24Z

Misheto: /* Developers */

A mapping of names to OOo accounts.

Abbrev.:

* PL : Project Lead
* CL : Project Co-Lead
* CC : Community Council Member
* ESC : Engineering Steering Committee Member
* CVS : has write access to the OOo CVS repository

----

=== Developers ===

{| class="prettytable sortable"
|-
! Name || CVS || @openoffice.org || [[IRC Communication]] || Notes || Affiliation
|-
| [[User:Agerskov|Claus Agerskov]]|| || cs||Agerskov, cagerskov||PL Project Management Tool ([http://oopm.openoffice.org oopm])||AgerCon
|-
| Volker Ahrendt|| X || va||||||Sun Microsystems
|-
| Kai Ahrens|| X || ka || Kai_Ahrens ||PL Graphic Applications||Sun Microsystems
|-
| Rail Aliev || X || rail || rail || Ru and Tr NL Co-lead || Infra-Resource
|-
| Gene Anaya|| || ganaya||||||
|-
| [[User:JoostAndrae|Joost Andrae]]|| X || ja||ja_||CL qa, release testing en-US builds and releasing/uploading builds and releases||Sun Microsystems
|-
| [[User:ericb|Eric Bachard]] || X || ericb||ericb2|| PL Education, Mac OSX/Linux PPC port and vcl/impress hacker || [http://education.openoffice.org Education project], unaffiliated
|-
| Kai Backman|| || kaib ||KaiB||||
|-
| Sascha Ballach|| X || sab||||||
|-
| Jayant Balraj Madavi|| || jayant_madavi||aZEN_JM||Connectivity / Database||Novell, Inc.
|-
| Jörg Barfurth|| X || jb||JoergB||Configuration Util||Sun Microsystems
|-
| Omer Bar-or|| X || cremlae||cremlae||Mac porting||Google Summer of Code
|-
| Mathias Bauer|| X || mba||||PL Writer, CL Framework, XML||Sun Microsystems
|-
| Thorsten Behrens|| X || thb||thorsten||vcl/impress/toolkit visionary||Novell, Inc.
|-
| Thomas Benisch|| X || tbe||||Scripting framework||Sun Microsystems
|-
| Stephan Bergmann|| X || sb||||CL UDK||Sun Microsystems
|-
| Andreas Bille|| X || abi||||||
|-
| Éric Bischoff|| X || ebischoff||ebischoff||KDE A/B driver||Bureau Cornavin
|-
| Nick Blievers|| X || nick||||IRIX||
|-
| Daniel Boelzle|| X || dbo||||UNO core/bridges/packages||Sun Microsystems
|-
| Oliver Bolte|| X || obo||||RE||Sun Microsystems
|-
| [[User:Cedricbosdo|Cédric Bosdonnat]]|| X || cedricbosdo || cbosdonnat || Writer Filters, ooeclipse integration || Novell, Inc.
|-
| Rafaella Braconi|| || coni||Rafaella ||PL l10n, Globalization Program Manager||Sun Microsystems
|-
| Michael Brauer|| X || mib||||PL XML||Sun Microsystems
|-
| Oliver Braun|| X || obr||obr||System Integration/Accessibility Hacker||Sun Microsystems
|-
| Andreas Bregas|| X || ab||||StarBasic||Sun Microsystems
|-
| Jörg Brunsmann|| || jbrunsmann||||UDK||
|-
| Jörg Budischewski|| || jbu||PyUNO hacker||||
|-
| Peter Burow|| X || pb||plumbumm||UI||Sun Microsystems
|-
| Aidan Butler|| || aidan||||XML filters||
|-
| [[User:ScottCarr|Scott Carr]] || X || kcarr||kcarr||PL Documentation||Progbits
|-
| Giuseppe Castagno || X || beppec56 || beppec56_ or beppe_c || PDF output||
|-
| Colin Charles|| || drbyte||bytee||Malaysian native-lang project||bytebot.net
|-
|Jian Hong Cheng || X || chengjh || || Writer || IBM Corp.
|-
| Xiuzhi Cheng|| X || xzcheng || xiuzhi|| ESC,Xml,ODF|| OOo community
|-
| [[User:jza|Alexandro Colorado]]|| X || jza || jza|| CL [[OOoES|ES]] ||
|-
| Behrend Cornelius|| X || bc||||Wizards||Sun Microsystems
|-
| [[User:ccornell|Clayton Cornell]] || X || ccornell || ccornell || Documentation Project co-lead ||Sun Microsystems
|-
| Michael Cziebalski|| || mci||||||
|-
| [[User:pdefilippis|Pierre de Filippis]]|| X || pdefilippis||aliscafo||Mac OSX native porting||
|-
| Yuri Dario || || ydario || Paperino || OS/2 Port || Serenity Systems intl
|-
| Andrew Dent|| X ||ace_dent||ace_dent||ui/custom_images||
|-
| Naren Devaiah|| || ||ndev||Performance||Intel Corporation
|-
| Nitin Dongre|| || ||nitin_BITS||||Novell, Inc.(intern)
|-
| Radek Doulik|| || radekdoulik||rodo_||Canvas hacker||Novell, Inc.
|-
| Carsten Driesner|| X || cd|| cd_oo ||PL Framework||Sun Microsystems
|-
| Herbert Duerr|| X || hdu||hdu_hh||GSL||Sun Microsystems
|-
| [[User:bei|Bernd Eilers]]|| X || bei||rfc821||[[EIS]]||Sun Microsystems
|-
| René Engelhard|| X || rene||_rene_||config_office, Debian packager||Debian
|-
| [[User:Pereriksson|Per Eriksson]] || || pereriksson || || CL, MarCon Sweden ||
|-
|[[User:Jbfaure|Jean-Baptiste Faure]]||X||jbfaure||jbfaure ||PL FR native-lang project||
|-
| Hubert Figuière|| X || hub || hub || PPTX || Novell, Inc.
|-
| Claudio F Filho|| || filhocf||filhocf||Brazilian portuguese Localization||BrOffice.org
|-
| Andre Fischer|| X || af||||Impress||Sun Microsystems
|-
| Uwe Fischer || X || ufi || ufiooo || Application Help || Sun Microsystems
|-
| Ken Foskey|| || waratah||waratah||config_office/dmake man||slug.org.au
|-
| Duncan Foster|| || dfoster||||||
|-
| David Fraser|| || davidfraser||davidfraser||South African translations, multilingual builds||translate.org.za
|-
| [[User:Nf|Nils Fuhrmann]]|| || nf||SunNF||||Sun Microsystems
|-
| Martin Gallwey|| X || mtg||marty_||XML/Writer/packaging||
|-
| Pierre-Andre Galmes || || pagalmes || pagalmes || Chart2 ||StarXpert
|-
| Tony Galmiche|| X || tonygalmiche||||FR native-lang project||
|-
| Sunil Gandhi|| || ||tyro||||NOSIP
|-
|Zemin Gao || || gaozemin|| gaozm || Calc || [[Beijing Redflag Chinese 2000 Software Co., Ltd.|Beijing Redflag CH2000]]
|-
| Sophie Gautier|| X || sgauti|| sophi || ||.
|-
| Vladimir Glazounov|| X || vg||||RE||Sun Microsystems
|-
| Laurent Godard || X || laurentgodard || lgodard || CC, PL Extensions, Fr Native-lang Project || inDesko/Nuxeo
|-
| Jody Goldberg|| X || jodygoldberg||jody||[[Calc]] spreadsheet-ness||
|-
| Dirk Grobler|| X || dg|||| ||Sun Microsystems
|-
| [[User:Sg|Steffen Grund]]|| X || sg|| || NetBeans Integration ||Sun Microsystems
|-
| Bettina Haberer|| || bh||||RFEOwner||Sun Microsystems
|-
| Bo Han || X || hanbo || hanbo || VBA Interop || [[Beijing Redflag Chinese 2000 Software Co., Ltd.|Beijing Redflag CH2000]]
|-
| Ingrid Halama|| X || iha||||Chart||Sun Microsystems
|-
| Chris Halls|| X || haggai||haggai||Debian packager&misc. hacker||Credativ Ltd., Debian
|-
| Gregor Hartmann|| X || gh|| Lachs ||Testtool, gsicheck, buildbot||Sun Microsystems
|-
| Bustamam Harun|| || bustamam||||Malaysian stuff||
|-
| Kevin Hendricks|| X || khendricks||||PL Lingucomponent, PowerPC||
|-
| Con Hennessy|| || cphennessy||cph2 or cph_||hacker & former council person||OpenApp
|-
| Ivo Hinkelmann|| X || ihi||ivo||l10n tooling/general/RE||Sun Microsystems
|-
| Eric Hoch|| X || maveric||mav_eric||Mac Porting||
|-
| [[User:Lutz_Hoeger|Lutz Hoeger]]|| X || lh ||lutzh||||Sun Microsystems
|-
| Michael Hönnig|| X || mi||||PL API||
|-
| Ilko Höpping|| X || ih||||||Sun Microsystems
|-
| Jan Holešovský|| X || kendy||kendy||KDE integration||Novell, Inc.
|-
| Martin Hollmichel|| X || mh||Ratte/Nesshof||PL External, Tools, Porting, CC||Sun Microsystems
|-
| Karl Hong|| X || khong||||i18n, CJK expert||
|-
| [[User:icobgr|Hristo Hristov]] || || icobgr || icobgr || PL Bulgarian native-lang project ||
|-
| Matthias Huetsch|| X || mhu||||Performance/strategy, PL UCB, CC, ESC||Sun Microsystems
|-
| Sven Jacobi|| X || sj||||Escherwizard||Sun Microsystems
|-
| Jörg Jahnke|| || jj||||tooling||Sun Microsystems
|-
| Pavel Janík|| X || pjanik||paveljanik||PL Czech native-lang project, CL l10n, CC, ESC, l10n builds||
|-
| Sunil Amitkumar Janki || || sjanki || sjanki || GNU Linux mipsel porter ||
|-
| Christian Jansen|| || cj ||||Menu and Toolbar?||Sun Microsystems
|-
| Ocke Janssen|| X || oj||Base||||Sun Microsystems
|-
| Berry Jia|| X || berryjia||||||
|-
| Mingfei Jia || X || jiamingfei || || Lotus Smart Suite filter,MS Word encryption || IBM Corp.
|-
| Chuang Jiang || || jiangc || || || [[Beijing Redflag Chinese 2000 Software Co., Ltd.|Beijing Redflag CH2000]]
|-
| Pascal Junck|| || pjunck||||||
|-
| [[User:pj@openoffice.org|Peter Junge]]|| X || pj|| peter13j|| OOo community contact ||
|-
| Christian Junker|| || Cyb||christianju||API||Trees For Life
|-
| Etsushi Kato || X || ekato || || Mac OS X Port || Independent
|-
| Hirano Kazunari|| || khirano||||Japanese||
|-
| Dhananjay Keskar|| X || dkeskar ||dkeskar||Performance,Buildbot,cat-herder||Intel Corporation
|-
| Volodymyr Khrystynych|| || volody||||XML Filter||
|-
| Robert Kinsella|| || rkinsella||||||Sun Microsystems
|-
| Matthias Klose|| || doko||doko||Ubuntu, gcc, python packager||Canonical, Inc.
|-
| Laszlo Kovacs|| || lkovacs||||Documentation||
|-
| Tobias Krause|| X || tkr||||ucb||Sun Microsystems
|-
| Martin Kretzschmar|| X || mkretzschmar||martink||Gnome / Debian||Student
|-
| Will Lachance|| || wlach||wlach_||Word Perfect File Filters||Net Integration Technologies, Inc.
|-
| Thomas Lange|| X || tl||tl13||||Sun Microsystems
|-
| Lars Langhans|| X || lla||||||Sun Microsystems
|-
| Hans-Joachim Lankenau|| X || hjs||ause||dmake makefile expert, RE||Sun Microsystems
|-
| Németh László|| X || nemeth||||PL lingucomponent||
|-
| Jakob Lechner|| X || jakob_lechner||||Writer||Fabalabs
|-
| Michael Leibowitz|| X || mikeleib ||mikeleib||performance||Intel Corporation
|-
| Hui Li|| || lihuiibm || Hui_Li ||VBA Interop||IBM Corp.
|-
|Jian Li|| || lijian || lijian|| Writer||
|-
| Wind Li|| X || windly||||Address books||
|-
| Xing Li || X || lixxing || || Accessibility || IBM Corp.
|-
|Weike Liang || || liangweike || liangweike || Graphics || [[Beijing Redflag Chinese 2000 Software Co., Ltd.|Beijing Redflag CH2000]]
|-
| Ping Liao|| || pliao||||||
|-
| Tor Lillqvist|| X || tml||tml_||||Novell, Inc.
|-
| Fong Lin || X || pflin || Fong || VBA Interop, Scripting, CJK Enhancement || Novell, Inc.
|-
| Joachim Lingner|| X || jl||||Java, CLI||Sun Microsystems
|-
| Christian Lippka|| X || cl || cl ||Graphic Applications||Sun Microsystems
|-
| Chen Liu|| || liuchenn|| liuchen ||VBA Interop||IBM Corp.
|-
|Jianli Liu || || liujl|| liujianli || Graphics|| [[Beijing Redflag Chinese 2000 Software Co., Ltd.|Beijing Redflag CH2000]]
|-
| Mindy Liu|| || mindyliu||||||
|-
|[[User:liutao |Tao Liu]] || X || liutao || liutao ||PL modularization ,PyUNO, Async dialogs,||
|-
| YiSong Liu|| || Liu YiSong || Liu YiSong|| PYUNO || [[Beijing Redflag Chinese 2000 Software Co., Ltd.|Beijing Redflag CH2000]]
|-
|Yu Liu || X || ch2000liuy || LiuYU || Swriter || [[Beijing Redflag Chinese 2000 Software Co., Ltd.|Beijing Redflag CH2000]]
|-
|Yuhua Liu || || liuyuhua|| yuhua|| ||[[Beijing Redflag Chinese 2000 Software Co., Ltd.|Beijing Redflag CH2000]]
|-
| [[User:fl|Frank Loehmann]]|| X || fl ||frankl||PL [http://ux.openoffice.org User Experience]||Sun Microsystems
|-
| [[User:Dl|Dieter Loeschky]]|| X || dl ||||PL: ODF Toolkit||Sun Microsystems
|-
| Philipp Lohmann|| X || pl||PhilippL||VCL/X11 (GSL) hacker||Sun Microsystems
|-
| Michel Loiseleur|| || mloiseleur|| coren`|| Bugfixes ||Linagora
|-
| Jackson Low|| X || xxjack12xx||||Porting||
|-
| Patrick Luby|| || pluby||||Mac||
|-
|Jingrong Luo || || Luo Jingrong|| Luo Jingrong|| ||[[Beijing Redflag Chinese 2000 Software Co., Ltd.|Beijing Redflag CH2000]]
|-
|Yue Lv || || lvyue || lvyue || Calc ||[[Beijing Redflag Chinese 2000 Software Co., Ltd.|Beijing Redflag CH2000]]
|-
|[[User:majun|Jun Ma]]|| ||majun51 || || writer || [[Beijing Redflag Chinese 2000 Software Co., Ltd.|Beijing Redflag CH2000]]
|-
| Prasad Madhav || X || pmadhav || pmadhav || Buildbot || Intern@Intel
|-
| Babak Mahbod|| || bmahbod||||||
|-
| Martin Maher|| || mmaher||||Writer & Filter chap||
|-
| Nakata Maho|| X || maho||_maho_||PL QA, PL JA, FreeBSD guy||Independent
|-
|Yonggang Mao || X || maoyonggang|| maoyg|| Calc ||
|-
| John Marmion|| X || jmarmion||||||
|-
| Andreas Martens|| X || ama||||PL Writer||Sun Microsystems
|-
| Shane M Mathews|| X || smmathews|| smmathews ||[[Impress:_OpenGL_rendered_transitions]]||student
|-
| Frank Mau|| X || fma||||tooling||Sun Microsystems
|-
| [[User:smsm1|Shaun McDonald]] || X || smsm1 || shaunmcdonald || Mac Port, buildbot MacPort1 || Graduate
|-
| Caolán McNamara|| X || cmc||caolan||CL Writer & Filter man|| [http://www.redhat.com Red Hat Inc.]
|-
| Michael Meeks|| X || mmeeks||michael_||ugly hack-er, ESC||Novell, Inc.
|-
| Frank Meies|| X || fme||||Writer||Sun Microsystems
|-
| Federico Mena-Quintero|| || federicomena||federico||perfectionist||Novell, Inc.
|-
| Ismael Merzaq|| X || isma87||ismael_||Mac OSX native porting||Student
|-
| Michael Mi|| || mmi||||||
|-
| Björn Michaelsen|| X || b_michaelsen ||b_michaelsen|| Writer, Bookmarks, Performance, User Feedback Program ||Sun Microsystems
|-
| Björn Milcke|| X || bm||bm_||Chart||Sun Microsystems
|-
| Petr Mladek|| || pmladek||pmladek||SUSE RPMs, ooo-build releases||Novell, Inc.
|-
| Cyrille Moureaux|| X || cyrillem||Cyrille||||
|-
| [[User:Mmp|Matthias Müller-Prove]]|| X || mmp|| mprove|| [[User Experience]] || Sun Microsystems
|-
| [[User:Bluedwarf|Takashi Nakamoto]]|| || bluedwarf|| || Japanese || Student
|-
| Jan Navrátil || X || jnavrati || jnavrati || || [http://www.redhat.com Red Hat Inc.]
|-
| Niklas Nebel|| X || nn||||PL [[Calc]]||Sun Microsystems
|-
| Christoph Neumann|| X || cn||||[[UnoApiTest]]||Sun Microsystems
|-
| Frank Neumann|| X || fne||||MacPort||
|-
| NicelKM|| X || mnicel||nicel||||Novell, Inc.
|-
| Jan Nieuwenhuizen|| X || jcn||janneke||Layout code, hacker ||Novell, Inc.
|-
| [[User:ChristophNoack|Christoph Noack]]|| X || christophnoack ||christoph_n||CL [http://ux.openoffice.org User Experience]||
|-
| Bertram Nolte|| || bnolte||||||
|-
| Tomas O'Connor|| || toconnor||||Scripting Framework||
|-
| Maximilian Odendahl|| X || mod||mod||[[Notes2]] [[SQL_Syntax_Highlighting]]|| Student / SEPT-Solutions
|-
| Takashi Ono || X || tono || || MinGW port || Independent
|-
| Lars Oppermann|| X || lo||||||
|-
| Rakesh Pandit || X || rakeshpandit|| chacha_chaudhry|| Education Project - Starmath/fix module warnings|| Education Project
|-
| Rodrigo Parra Novo|| X || rodarvus||rodarvus||Gnumeric/Abiword OpenDocument Format support and port to Maemo||INdT (Instituto Nokia de Tecnologia)
|-
| Pierre Pasteau|| X || pastea_p || pierrep|| Education Project, SeaMonkey migration || Education Project
|-
| Edward Peterlin|| X || OPENSTEP||||Mac||
|-
| [[User:Fpe|Frank Peters]]|| X || fpe||||CL Documentation||Sun Microsystems
|-
| Christof Pintaske|| X || cp||||||Sun Microsystems
|-
| Ron Piterman|| || rpiterman||||||
|-
| Sebastien Plisson|| X || plipli||plipli||Developer on Aqua port||OO Aqua Port
|-
| Noel Power|| || npower||noelp||VBA Interop, Scripting||Novell, Inc.
|-
| Nikolai Pretzell|| X || np || ||Autodoc, code quality||Sun Microsystems
|-
| Jonathan Pryor|| || jpryor || jonp || || Novell, Inc.
|-
| Canghua Qu|| || quch || Canghua || AutoTest, Graphics || [[Beijing Redflag Chinese 2000 Software Co., Ltd.|Beijing Redflag CH2000]]
|-
| Volker Quetschke|| X || vq||vq||W32-tcsh/bash build environment and dmake Hacker, ESC||Gravity Waves
|-
| Tino Rachui|| X || tra||tinor||GSL/Unix Hacker||Sun Microsystems
|-
| Goran Rakić || X ||goranrakic || || Serbian Native-Lang PL ||
|-
| [[User:Kr|Kay Ramme]]|| X || kr||||PL UDK||Sun Microsystems
|-
| [[User:ErAck|Eike Rathke]]|| X || er||erAck||CL [[Calc]], engine; CL i18n; stricken with number formatter||Sun Microsystems
|-
| Michael Rauch|| X || mrauch||||NetBSD||
|-
| Jens-Heiner Rechtien|| X || hr||blauwal||RE; OOo SCM (CVS, CWS tooling); Porting; Compilers||Sun Microsystems
|-
| Daniel Rentz|| X || dr|| drr ||[[Calc]] Excel filter, UI||Sun Microsystems
|-
| Florian Reuter|| X || flr||||Writer filters||Novell, Inc.
|-
| Georg Richter|| X || grichter||georg||Base, native MySQL driver||MySQL AB
|-
| G. Roderick Singleton|| || grsingleton||grsingleton||Documentation||pathtech.org
|-
| Hennes Rohling|| X || hro||||GSL & Util||Sun Microsystems
|-
| Bibek Sahu|| || Bibek||bibek||Impress pieces||Trees For Life
|-
| Andreas Schlüns|| X || as||||Framework||Sun Microsystems
|-
| Ingo Schmidt|| X || is||||(Native) Installation||Sun Microsystems
|-
| [[User:Jsc|Jürgen Schmidt]]|| X || jsc||jsc||PL API, PL Extensions, UNO, SDK||Sun Microsystems
|-
| [[User:Schmidtm|Matthias Schmidt]] || || schmidtm || schmidtm || Mac OSX Aqua Port || Sun Microsystems
|-
| Stephan Schäfer|| X || ssa||ssa||VCL||Sun Microsystems
|-
| Frank Schönheit|| X || fs||FrankS||Database Access, Forms||Sun Microsystems
|-
| [[User:Sus|Svante Schubert]]|| X || sus||Svante||XML & ODFTOOLKIT co-lead, ODFDOM project chair, Member of OASIS ODF TC, OASIS OIC TC, OASIS ODF SC Metadata||Sun Microsystems
|-
| [[User:Sts|Stella Schulze]]|| X || sts||||[http://ui.openoffice.org/nonav/VisualDesign/ Visual Design]||Sun Microsystems
|-
| Julian Seward || || sewardj || || valgrind ||
|-
| Darragh Sherwin|| || dsherwin||darragh||E-Legislation / E-GovSystems||Propylon
|-
| Wei Guo Shi || X || shiwg || || Accessibility and Smart Suite filter || IBM Corp.
|-
|[[User:Robertzhou | RobertZhou]]|| || robertzhou|| shizhoubo|| [[Framework]] || CS2C
|-
| Raul Siddhartha|| || rsiddhartha||raul||GTK File Selector||Novell, Inc.
|-
| Sarah Smith|| || ssmith||||||
|-
| [[User:mox|Mox Soini]] || X || mox || Moxed || Mac Porting ||
|-
| Rajesh Sola|| || rajeshsola||sola||misc.||NOSIP
|-
| Kai Sommerfeld|| X || kso||||manager & hacker||Sun Microsystems
|-
| Oliver Specht|| X || os||||PL UI||Sun Microsystems
|-
| Jörg Spindler|| || jspindler||||||
|-
| [[User:Rescue|Joey Stanford]] || || Rescue/k0fcc || Rinchen || CL [http://eo.openoffice.org/ Esperanto native-lang project] || [http://canonical.com Canonical]
|-
| Fridrich Štrba|| X || fridrich_strba||Fridrich||Word Perfect Hacker||Novell, Inc.
|-
| Keith Stribley|| X || kstribley||||Graphite fonts, Myanmar l10n||
|-
| [[User:Muthusuba|Muthu Subramanian]]|| X || muthusuba||muthusuba||misc.||
|-
| Louis Suárez-Potts|| || louis||louis||Community Manager||Collab.net
|-
|Quanfa Tang || || tqfa|| tangquanfa|| Calc || [[Beijing Redflag Chinese 2000 Software Co., Ltd.|Beijing Redflag CH2000]]
|-
| David Tardon || X || dtardon || dtardon || || [http://www.redhat.com Red Hat Inc.]
|-
| Stefan Taxhet|| X || st||stx12||CC, interpersonal problem fixer||Sun Microsystems
|-
| Armin Theissen|| || armin||||||
|-
| Caio Tiago Oliveira|| X || asrail||asrail||CL QA, release testing pt-BR builds||BrOffice.org
|-
| Jan Tietjens|| || tietjens||||||
|-
| Rüdiger Timm|| X || rt|| rtimm ||RE||Sun Microsystems
|-
| [[User:mt|Malte Timmermann]]|| X || mt|| Malte || Accessibility, Security, Performance||Sun Microsystems
|-
| Gerhard Tonn|| || tonn||||s390||
|-
| Willem van Dorp|| || willem.vandorp||||||
|-
| Tom Verbeek|| X || tv|||| ||
|-
| Sander Vesik|| || svesik||||||
|-
| Daniel Vogelheim|| X || dvo||||XML||
|-
| Mikhail Voitenko|| X || mav||mav||Framework||Sun Microsystems
|-
| Robert Vojta|| X || rvojta||rvojta||Mac OS X related issue||
|-
| Dirk Völzke|| X || dv||||Installation||Sun Microsystems
|-
|Xu Ming Wang || X || flyccloud or Wangxum || || Calc || IBM Corp.
|-
| [[User:Sparcmoz|Jim Watson]]|| X || sparcmoz|| sparcmoz||GNU Linux sparc porter||clug.org.au
|-
| [[User:Weiz |Zhao Wei ]] || || weiz || weiz || Chart2 || [[Beijing Redflag Chinese 2000 Software Co., Ltd.|Beijing Redflag CH2000]]
|-
| Armin Weiss|| X || aw||||||Sun Microsystems
|-
| Gerd Weiss|| X || gm||||RE||Sun Microsystems
|-
| Dan Williams|| X || fa||dcbw||Mac et. al. hacker|| [http://www.redhat.com Red Hat Inc.]
|-
| Oliver Wittmann|| X || od||Writer||||Sun Microsystems
|-
|[[User:wuy|Yan Wu]] || X || wuy || ||Framework ||CS2C
|-
| Stephan Wunderlich|| X || sw||||||
|-
| Antonio Xu|| X || antoxu || antoxu || Async dialogs, PRC improvements || Intel Corporation
|-
|Dehua Xu || || xudehua || xudh ||||
|-
| Steve Yin || X || steve_yin || steve_yin || Microsoft Office file format, PDF, Accessibility, ODF || IBM Corp.
|-
| Kohei Yoshida|| X || kohei||kohei_||[[Calc]] hacker, Calc optimization solver developer||Novell, Inc.
|-
| Guoqiang Yu|| X || yugq || yugq|| Performance || [[Beijing Redflag Chinese 2000 Software Co., Ltd.|Beijing Redflag CH2000]]
|-
| Xiaoyang Yu|| || || ||Disk block reordering||Intel Corporation
|-
| George Zahopoulos|| X || georgez||||||
|-
| Kurt Zenker|| X || kz||smoketester||RE||Sun Microsystems
|-
|[[User:Zhangxiaofei|Xiaofei Zhang]]|| || Zhangxiaofei || zhangxiaofei/FelixZ || [[Framework]] ||[[Beijing Redflag Chinese 2000 Software Co., Ltd.|Beijing Redflag CH2000]]
|-
|Jianwei Zhao || || zhaojianwei || zhaojianwei || Swriter || [[Beijing Redflag Chinese 2000 Software Co., Ltd.|Beijing Redflag CH2000]]
|-
| Jeremy Zheng|| X || zhiming || Jeremy || Async dialogs, PRC improvements || Intel Corporation
|-
| Mihaela Kedikova|| X || misheto||||grid control||Sun Microsystems
|}

=== QA Engineers ===

{| border="2" cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em 0; background: #f9f9f9; border: 1px #aaa solid; border-collapse: collapse;"
|-
! Name ||CVS||@openoffice.org || [[IRC Communication]] || Interested modules || Notes || Affiliation
|-
| Stefan Baltzer||||sba||||writer||||Sun Microsystems
|-
| Thorsten Bosbach||X||tbo||||framework, testautomation||framework test automation||Sun Microsystems
|-
| Oliver Craemer||X||oc||||[[Calc]], testautomation||calc test automation||Sun Microsystems
|-
| Helge Delfs||X||hde||||testautomation, writer||Test automation||Sun Microsystems
|-
| Fredrik Haegg||X||fha||||writer, testautomation||Writer test automation||
|-
| Hasan Ilter||||hi||||writer, printing, pdf export||||Sun Microsystems
|-
| Michael Rüß||||mru||||writer, word im/export||||Sun Microsystems
|-
| Éric Savary||||es||||writer, accessibility||||Sun Microsystems
|-
| [[User:jsi|Joerg Sievers]]||X||jsi||jsi_sun||chart, xml, testautomation||Chart2, XML test automation||Sun Microsystems
|-
| Joerg Skottke||X||jsk||skotti||framework, qa/qatesttool||Framework test automation||Sun Microsystems
|-
| Marc Neumann||X||msc||||database, testautomation||Database access test automation||Sun Microsystems
|-
| Chris Lukasiak||||clu||||database||||Sun Microsystems
|-
| Frank Stecher||||fst||||[[Calc]]||||Sun Microsystems
|-
| Jack Warchold|||| jw||||writer, import/export filters||||
|-
| Uwe Luebbers||||ul||||framework||||Sun Microsystems
|-
| Thorsten Martens||||tm||||framework||||Sun Microsystems
|-
| Olaf Felka|||| of||of_sun||framework, installation||||Sun Microsystems
|-
| Thomas Klarhoefer||||kla||||chart||||Sun Microsystems
|-
| Wolfram Garten||X|| wg||||draw, impress||draw, impress test automation||Sun Microsystems
|-
| Christian Guenther||||cgu||||draw, impress||||Sun Microsystems
|-
| Ulf Stroehler|| || us||||||Sun Microsystems
|-
| [[User:Thorsten_Ziehm|Thorsten Ziehm]]||||| thorstenziehm||||||QA lead||Sun Microsystems
|}

We are tracking pending JCAs in the document [[Pending JCAs]].

== Related Pages ==
* [[Commit Rights]]
* [[Contributing Patches]]
* [[User_Experience/Community|User Experience Team]]
* A map of OOo developers around the world is available at http://www.frappr.com/ooodev, please add yourself to the map if you're involved in OOo development. It's just fun to see who's where :-)

[[Category:Development]]

API/UNO AWT/Grid Control

2009-11-25T12:06:41Z

Misheto: /* Planned Iteration */

{{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 || - || new ||
|-
|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 || - || new ||
|-
|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 || - || new ||
|}

==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 | nominated || ||
To do:
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 3 || || style="background-color: #FFFF00;" align=center | in progress || ||
To do:
* modify column and row size
* exception handling
* Different data types
* A11y
||
* 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]]

API/UNO AWT/Grid Control

2009-11-25T12:05:51Z

Misheto: /* Supported Listeners */

{{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 || - || new ||
|-
|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 || - || new ||
|-
|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 || - || new ||
|}

==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 | ready for QA || ||
To do:
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 3 || || style="background-color: #FFFF00;" align=center | open || ||
To do:
* modify column and row size
* exception handling
* Different data types
* A11y
||
* 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]]

API/UNO AWT/Grid Control

2009-11-04T13:31:12Z

Misheto: /* Planned Iteration */

{{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 || - || new ||
|-
|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 || - || new ||
|-
|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 || - || new ||
|}

==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 | ready for QA || ||
To do:
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 3 || || style="background-color: #FFFF00;" align=center | open || ||
To do:
* modify column and row size
* exception handling
* Different data types
* A11y
||
* 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]]

API/UNO AWT/Grid Control

2009-10-06T09:30:51Z

Misheto: /* Planned Iteration */

{{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 || - || new ||
|-
|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 || - || new ||
|-
|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 || - || new ||
|}

==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 | QA || ||
To do:
* UnoControl
* Selection
* Textdata only
* Eventhandling
* Scrollbars
* Scrollbar modi
* Column and row headers
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 2 || 2009-10-16 || style="background-color: #C0FFC0;" align=center | in progress || ||
To do:
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 3 || || style="background-color: #FFFF00;" align=center | open || ||
To do:
* modify column and row size
* exception handling
* Different data types
* A11y
||
* 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]]

API/UNO AWT/Grid Control

2009-09-29T10:15:29Z

Misheto: /* Example */ (checkpoint save)

{{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 || - || new ||
|-
|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 || - || new ||
|-
|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 || - || new ||
|}

==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 | QA || ||
To do:
* UnoControl
* Selection
* Textdata only
* Eventhandling
* Scrollbars
* Scrollbar modi
* Column and row headers
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 2 || || style="background-color: #C0FFC0;" align=center | in progress || ||
To do:
* Eventhandling
* Different data types
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 3 || || style="background-color: #FFFF00;" align=center | open || ||
To do:
* modify column and row size
* exception handling
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center |4 || || style="background-color: #FFFF00;" align=center | open|| ||
To do:
* Auto resizing
* 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]]

API/UNO AWT/Grid Control

2009-09-22T13:33:00Z

Misheto: /* Planned Iteration */

{{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:'''

<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>

'''Add the columns to the column model of the grid control:'''

<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>

'''Use the data model of the grid control to add rows:'''

<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>

'''Create the grid model and assign the column and data model:'''
<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>

== 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 || - || new ||
|-
|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 || - || new ||
|-
|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 || - || new ||
|}

==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 | QA || ||
To do:
* UnoControl
* Selection
* Textdata only
* Eventhandling
* Scrollbars
* Scrollbar modi
* Column and row headers
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 2 || 2009-09-30 || style="background-color: #C0FFC0;" align=center | in progress || ||
To do:
* Eventhandling
* Different data types
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 3 || || style="background-color: #FFFF00;" align=center | open || ||
To do:
* modify column and row size
* exception handling
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center |4 || || style="background-color: #FFFF00;" align=center | open|| ||
To do:
* Auto resizing
* 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]]

API/UNO AWT/Grid Control

2009-08-05T13:58:41Z

Misheto: /* Key And Mouse Usage */

{{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.

== Overview ==
[[Image:Overview_gridcontrol.png]]

== Example ==

'''Create new columns:'''

<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>

'''Add the columns to the column model of the grid control:'''

<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>

'''Use the data model of the grid control to add rows:'''

<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>

'''Create the grid model and assign the column and data model:'''
<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("DataModel", xGridDataModel);
</source>

== Event Handling ==
{| 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 || ||
|-
| || mouseExited || ||
|-
| '''XGridSelectionListener''' || || ''Not yet implemented.''
|-
| || selectionChanged ||
|-
|}

== 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 || - || new ||
|-
|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 || - || new ||
|-
|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 || - || new ||
|}

==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 | QA || ||
To do:
* UnoControl
* Selection
* Textdata only
* Eventhandling
* Scrollbars
* Scrollbar modi
* Column and row headers
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 2 || 2009-08-28 || style="background-color: #C0FFC0;" align=center | in progress || ||
To do:
* Eventhandling
* Different data types
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 3 || || style="background-color: #FFFF00;" align=center | open || ||
To do:
* modify column and row size
* exception handling
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center |4 || || style="background-color: #FFFF00;" align=center | open|| ||
To do:
* Auto resizing
* 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]]

API/UNO AWT/Grid Control

2009-08-05T13:56:38Z

Misheto: /* Planned Iteration */

API/UNO AWT/Grid Control

2009-08-05T13:54:06Z

Misheto: /* Event Handling */

{{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.

== Overview ==
[[Image:Overview_gridcontrol.png]]

== Example ==

'''Create new columns:'''

<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>

'''Add the columns to the column model of the grid control:'''

<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>

'''Use the data model of the grid control to add rows:'''

<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>

'''Create the grid model and assign the column and data model:'''
<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("DataModel", xGridDataModel);
</source>

== Event Handling ==
{| 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 || ||
|-
| || mouseExited || ||
|-
| '''XGridSelectionListener''' || || ''Not yet implemented.''
|-
| || selectionChanged ||
|-
|}

== 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 || - || new ||
|-
|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 || - || new ||
|-
|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 || - || new ||
|}

==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 | QA || ||
To do:
* UnoControl
* Selection
* Textdata only
* Eventhandling
* Scrollbars
* Scrollbar modi
* Column and row headers
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 2 || 2009-08-28 || style="background-color: #C0FFC0;" align=center | in progress || ||
To do:
* Eventhandling
* Different data types
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 3 || || style="background-color: #FFFF00;" align=center | open || ||
To do:
* modify column and row size
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center |4 || || style="background-color: #FFFF00;" align=center | open|| ||
To do:
* Auto resizing
* 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
.
|}

* Keys
* Resizing

[[Category:API]]
[[Category:UNO AWT]]

API/UNO AWT/Grid Control

2009-06-18T13:31:44Z

Misheto: /* Abstract */

{{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.

==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

==Milestones==
{| 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-06-30 || style="background-color: #C0FFC0;" align=center | in progress || ||
To do:
* UnoControl
* Selection
* Textdata only
* Eventhandling
* Scrollbars
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 2 || || style="background-color: #FFFF00;" align=center | open|| ||
To do:
* Scrollbar modi
* Column and row headers
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 3 || || style="background-color: #FFFF00;" align=center | open || ||
To do:
* modify column and row size
* Auto resizing
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center |4 || || style="background-color: #FFFF00;" align=center | open|| ||
To do:
* different data types
* 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==

* Selection
** only row selection is possible
** selection possibilities with the mouse
*** mouse click in a cell: single row selection
*** Ctrl + mouse click in a cell: multiple rows selection possible, if row has been already selected, deselects it
*** Shift + mouse click in a cell: multiple rows selection, range is between current row and the chosen one
** selection possibilities with the keyboard
*** Ctrl + Alt: single row selection, if row has been already selected, deselects it
*** Shift + UP: multiple rows selection above current row, if rows above the current one have been already selected, they can be deselected one by one
*** Shift + DOWN: multiple rows selection beneath current row, if rows beneath the current one have been already selected, they can be deselected one by one
*** Shift + HOME: multiple row selection, range is between current row and top one
*** Shift + END: multiple row selection, range is between current row and bottom one

* Keys
* Resizing

[[Category:API]]
[[Category:UNO AWT]]

API/UNO AWT/Grid Control

2009-06-18T13:13:47Z

Misheto:

{{DISPLAYTITLE:UNO Grid Control}}
=Abstract=
OpenOffice.org hasn't a Table or Grid Control via UNO API today. The goal of this feature is to develop and implement a UNO Grid Control.
==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

==Milestones==
{| 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-06-30 || style="background-color: #C0FFC0;" align=center | in progress || ||
To do:
* UnoControl
* Selection
* Textdata only
* Eventhandling
* Scrollbars
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 2 || || style="background-color: #FFFF00;" align=center | open|| ||
To do:
* Scrollbar modi
* Column and row headers
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center | 3 || || style="background-color: #FFFF00;" align=center | open || ||
To do:
* modify column and row size
* Auto resizing
* A11y
||
* UNO
** IDL
** Impl.
*VCL
** Impl.
|-
| align=center |4 || || style="background-color: #FFFF00;" align=center | open|| ||
To do:
* different data types
* 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==

* Selection
** only row selection is possible
** selection possibilities with the mouse
*** mouse click in a cell: single row selection
*** Ctrl + mouse click in a cell: multiple rows selection possible, if row has been already selected, deselects it
*** Shift + mouse click in a cell: multiple rows selection, range is between current row and the chosen one
** selection possibilities with the keyboard
*** Ctrl + Alt: single row selection, if row has been already selected, deselects it
*** Shift + UP: multiple rows selection above current row, if rows above the current one have been already selected, they can be deselected one by one
*** Shift + DOWN: multiple rows selection beneath current row, if rows beneath the current one have been already selected, they can be deselected one by one
*** Shift + HOME: multiple row selection, range is between current row and top one
*** Shift + END: multiple row selection, range is between current row and bottom one

* Keys
* Resizing

[[Category:API]]
[[Category:UNO AWT]]