Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: awt :: grid ::

interface XGridColumn
Base Interfaces
XGridColumn
┣ ::com::sun::star::lang::XComponent
┗ ::com::sun::star::util::XCloneable

::com::sun::star::lang::XComponent
Description
implements life time control for the component
::com::sun::star::util::XCloneable
Description
allows cloning the complete grid column
Description
The XGridColumn defines the properties and behavior of a column in a grid control
Since
OOo 3.3

Methods' Summary
addGridColumnListener Adds a listener for the GridColumnEvent posted after the grid changes.  
removeGridColumnListener Removes a listener previously added with addColumnListener().  
Attributes' Summary
Identifier specifies an identifier of the column  
ColumnWidth specifies the current width of the column.  
MinWidth specifies the minimal width the column can have.  
MaxWidth specifies the maximal width the column can have.  
Resizeable controls whether or not the column's width is fixed or not.  
Flexibility specifies the flexibility of the column when it is automatically resized due to the grid control as a whole being resized.  
HorizontalAlign Specifies the horizontal alignment of the content in the control.  
Title A title is displayed in the colum header row if UnoControlGridModel::ShowRowHeader is set to true 
HelpText is the help text associated with the column.  
Index denotes the index of the column within the grid column model it belongs to  
DataColumnIndex denotes the index of the data column which should be used to fetch this grid column's data  
Methods' Details
addGridColumnListener
void
addGridColumnListener( [in] XGridColumnListener  listener );

Description
Adds a listener for the GridColumnEvent posted after the grid changes.
Parameter Listener
the listener to add.
removeGridColumnListener
void
removeGridColumnListener( [in] XGridColumnListener  listener );

Description
Removes a listener previously added with addColumnListener().
Parameter Listener
the listener to remove.
Attributes' Details
Identifier
any Identifier;
Description
specifies an identifier of the column

This identifier will not be evaluated by the grid control, or its model. It is merely for clients to identify particular columns.

ColumnWidth
long ColumnWidth;
Description
specifies the current width of the column.
MinWidth
long MinWidth;
Description
specifies the minimal width the column can have.
MaxWidth
long MaxWidth;
Description
specifies the maximal width the column can have.
Resizeable
boolean Resizeable;
Description
controls whether or not the column's width is fixed or not.

If this is true, the user can interactively change the column's width. Also, the column is subject to auto-resizing, if its Flexibility attribute is greater 0.

Flexibility
long Flexibility
set raises (::com::sun::star::lang::IllegalArgumentException);

Description
specifies the flexibility of the column when it is automatically resized due to the grid control as a whole being resized.

Specify 0 here if you do not want the column to be resized automatically.

If a column has a flexibility greater than 0, it is set in relationship to the flexibility of all other such columns, and the respective widths of the columns are changed in the same relationship.

Note that a column's flexibility is ignored if its Resizeable attribute is false.

A column's flexibility cannot be negative, attempts to set a negative value will raise an exception.

HorizontalAlign
::com::sun::star::style::HorizontalAlignment HorizontalAlign;
Description
Specifies the horizontal alignment of the content in the control.
Title
string Title;
Description
A title is displayed in the colum header row if UnoControlGridModel::ShowRowHeader is set to true
HelpText
string HelpText;
Description
is the help text associated with the column.

A grid control will usually display a column's help text as tooltip.

Index
[ readonly ] long Index;
Description
denotes the index of the column within the grid column model it belongs to

If the column is not yet part of a column model, Index is -1.

DataColumnIndex
long DataColumnIndex;
Description
denotes the index of the data column which should be used to fetch this grid column's data

A grid control has a column model and a data model, both containing a possibly different number of columns. The DataColumnIndex attribute defines the index of the column within the data model, which should be used to retrieve actual data.

Using this, you can do runtime changes to the column model, i.e. insertion and removal of columns, without necessarily needing to adjust the data model, too.

If DataColumnIndex is negative, the it will be ignored, then the column's index within its column model, as determined by the Index attribute, will be used.

Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.