Java Doc for Table.java in  » Web-Framework » Millstone » org » millstone » base » ui » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Web Framework » Millstone » org.millstone.base.ui 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.millstone.base.ui.AbstractComponent
      org.millstone.base.ui.AbstractField
         org.millstone.base.ui.Select
            org.millstone.base.ui.Table

Table
public class Table extends Select implements Action.Container,Container.Ordered,Container.Sortable(Code)
Table component is used for representing data or components in pageable and selectable table.
author:
   IT Mill Ltd.
version:
   3.1.1 @since 3.0


Field Summary
final public static  StringALIGN_CENTER
     Center column alignment.
final public static  StringALIGN_LEFT
     Left column alignment.
final public static  StringALIGN_RIGHT
     Right column alignment.
final public static  intCOLUMN_HEADER_MODE_EXPLICIT
    
final public static  intCOLUMN_HEADER_MODE_EXPLICIT_DEFAULTS_ID
    
final public static  intCOLUMN_HEADER_MODE_HIDDEN
     Column header mode: Column headers are hidden.
final public static  intCOLUMN_HEADER_MODE_ID
     Column header mode: Property ID:s are used as column headers.
final public static  intROW_HEADER_MODE_EXPLICIT
     Row caption mode: Item captions are explicitly specified.
final public static  intROW_HEADER_MODE_EXPLICIT_DEFAULTS_ID
     Row caption mode: Item captions are explicitly specified, but if the caption is missing, the item id objects toString() is used instead.
final public static  intROW_HEADER_MODE_HIDDEN
     Row caption mode: The row headers are hidden.
final public static  intROW_HEADER_MODE_ICON_ONLY
     Row caption mode: Only icons are shown, the captions are hidden.
final public static  intROW_HEADER_MODE_ID
     Row caption mode: Items Id-objects toString() is used as row caption.
final public static  intROW_HEADER_MODE_INDEX
     Row caption mode: Index of the item is used as item caption.
final public static  intROW_HEADER_MODE_ITEM
     Row caption mode: Item-objects toString() is used as row caption.
final public static  intROW_HEADER_MODE_PROPERTY
     Row caption mode: Item captions are read from property specified with setItemCaptionPropertyId.

Constructor Summary
public  Table()
    
public  Table(String caption)
     Create new empty table with caption.
public  Table(String caption, Container dataSource)
     Create new table with caption and connect it to a Container.

Method Summary
public  voidaddActionHandler(Action.Handler actionHandler)
    
public  booleanaddContainerProperty(Object propertyId, Class type, Object defaultValue)
     Adds a new property to the table and show it as a visible column.
public  booleanaddContainerProperty(Object propertyId, Class type, Object defaultValue, String columnHeader, Resource columnIcon, String columnAlignment)
     Adds a new property to the table and show it as a visible column.
See Also:   org.millstone.base.data.Container.addContainerProperty(ObjectClassObject)
Parameters:
  propertyId - Id of the proprty
Parameters:
  type - The class of the property
Parameters:
  defaultValue - The default value given for all existing items
Parameters:
  columnHeader - Explicit header of the column.
public  ObjectaddItem(Object[] cells, Object itemId)
     Add new row to table and fill the visible cells with given values.
Parameters:
  cells - Object array that is used for filling the visible cells newrow.
public  ObjectaddItemAfter(Object previousItemId)
    
public  ItemaddItemAfter(Object previousItemId, Object newItemId)
    
public  voidattach()
    
public  voidchangeVariables(Object source, Map variables)
     Invoked when the value of a variable has changed.
public  voidcontainerItemSetChange(Container.ItemSetChangeEvent event)
     Container datasource item set change.
public  voidcontainerPropertySetChange(Container.PropertySetChangeEvent event)
     Container datasource property set change.
public  voiddetach()
    
public  ObjectfirstItemId()
    
public  voidfocus()
     Focusing to this component is not supported.
protected  StringformatPropertyValue(Object rowId, Object colId, Property property)
     Formats table cell property values.
public  StringgetColumnAlignment(Object propertyId)
     Gets the specified column's alignment.
Parameters:
  propertyId - the propertyID identifying the column.
public  String[]getColumnAlignments()
     Get array of column alignments.

The items in the array must match the properties identified by getVisibleColumns().

public  StringgetColumnHeader(Object propertyId)
     Gets the header for the specified column.
Parameters:
  propertyId - the propertyId indentifying the column.
public  intgetColumnHeaderMode()
     Getter for property columnHeaderMode.
public  String[]getColumnHeaders()
     Get the headers of the columns.

The headers match the property id:s given my the set visible column headers.

public  ResourcegetColumnIcon(Object propertyId)
     Gets the icon Resource for the specified column.
Parameters:
  propertyId - the propertyId indentifying the column.
public  Resource[]getColumnIcons()
     Get the icons of the columns.

The icons in headers match the property id:s given my the set visible column headers.

public  ObjectgetCurrentPageFirstItemId()
     Getter for property currentPageFirstItem.
public  intgetCurrentPageFirstItemIndex()
     Getter for property currentPageFirstItem.
public  FieldFactorygetFieldFactory()
     Get the FieldFactory that is used to create editor for table cells.
public  intgetPageLength()
     Get the page length.
protected  ObjectgetPropertyValue(Object rowId, Object colId, Property property)
     Get value of property. By default if the table is editable the fieldFactory is used to create editors for table cells.
public  intgetRowHeaderMode()
     Get the row header mode.
public  ObjectgetSortContainerPropertyId()
     Get the currently sorted column property ID.
public  CollectiongetSortableContainerPropertyIds()
    
public  StringgetTag()
     Get UIDL tag corresponding to component.
public  Object[]getVisibleColumns()
     Get the array of visible column property id:s.
public  CollectiongetVisibleItemIds()
    
public  booleanisColumnCollapsed(Object propertyId)
     Checks if the specified column is collapsed.
Parameters:
  propertyId - the propertyID identifying the column.
public  booleanisColumnCollapsingAllowed()
     Check if column collapsing is allowed.
public  booleanisColumnReorderingAllowed()
     Check if column reordering is allowed.
public  booleanisEditable()
     Is table editable. If table is editable a editor of type Field is created for each table cell.
public  booleanisFirstId(Object itemId)
    
public  booleanisLastId(Object itemId)
    
public  booleanisPageBufferingEnabled()
     Getter for property pageBuffering.
public  booleanisSelectable()
     Getter for property selectable.
public  booleanisSortAscending()
     Is the table currently sorted in ascending order.
public  booleanisSortDisabled()
     Is sorting disabled alltogether.
public  ObjectlastItemId()
    
public  ObjectnextItemId(Object itemId)
    
public  voidpaintContent(PaintTarget target)
     Paint the content of this component.
public  ObjectprevItemId(Object itemId)
    
public  voidrefreshCurrentPage()
     Refresh the current page contents.
public  voidremoveActionHandler(Action.Handler actionHandler)
    
public  booleanremoveAllItems()
    
public  booleanremoveContainerProperty(Object propertyId)
    
public  booleanremoveItem(Object itemId)
    
public  voidsetColumnAlignment(Object propertyId, String alignment)
     Sets the specified column's alignment.
public  voidsetColumnAlignments(String[] columnAlignments)
     Set the column alignments.

The items in the array must match the properties identified by getVisibleColumns().

public  voidsetColumnCollapsed(Object propertyId, boolean collapsed)
     Sets whether the specified column is collapsed or not.
public  voidsetColumnCollapsingAllowed(boolean collapsingAllowed)
     Sets whether column collapsing is allowed or not.
public  voidsetColumnHeader(Object propertyId, String header)
    
public  voidsetColumnHeaderMode(int columnHeaderMode)
     Setter for property columnHeaderMode.
public  voidsetColumnHeaders(String[] columnHeaders)
     Set the headers of the columns.

The headers match the property id:s given my the set visible column headers.

public  voidsetColumnIcon(Object propertyId, Resource icon)
     Sets the icon Resource for the specified column.
public  voidsetColumnIcons(Resource[] columnIcons)
     Set the icons of the columns.

The icons in headers match the property id:s given my the set visible column headers.

public  voidsetColumnReorderingAllowed(boolean reorderingAllowed)
     Sets whether column reordering is allowed or not.
public  voidsetContainerDataSource(Container newDataSource)
    
public  voidsetCurrentPageFirstItemId(Object currentPageFirstItemId)
     Setter for property currentPageFirstItem.
public  voidsetCurrentPageFirstItemIndex(int newIndex)
     Setter for property currentPageFirstItem.
public  voidsetEditable(boolean editable)
     Set the editable property. If table is editable a editor of type Field is created for each table cell.
public  voidsetFieldFactory(FieldFactory fieldFactory)
     Set the FieldFactory that is used to create editor for table cells. The FieldFactory is only used if the Table is editable.
public  voidsetNewItemsAllowed(boolean allowNewOptions)
     Adding new items is not supported.
public  voidsetPageBufferingEnabled(boolean pageBuffering)
     Setter for property pageBuffering.
public  voidsetPageLength(int pageLength)
     Set the page length.

Setting page length 0 disables paging.

public  voidsetRowHeaderMode(int mode)
     Set the row header mode.

The mode can be one of the following ones:

  • ROW_HEADER_MODE_HIDDEN: The row captions are hidden.
  • ROW_HEADER_MODE_ID: Items Id-objects toString() is used as row caption.
  • ROW_HEADER_MODE_ITEM: Item-objects toString() is used as row caption.
  • ROW_HEADER_MODE_PROPERTY: Property set with setItemCaptionPropertyId() is used as row header.
  • ROW_HEADER_MODE_EXPLICIT_DEFAULTS_ID: Items Id-objects toString() is used as row header.
public  voidsetSelectable(boolean selectable)
     Setter for property selectable.
public  voidsetSortAscending(boolean ascending)
     Set the table in ascending order.
public  voidsetSortContainerPropertyId(Object propertyId)
     Set the currently sorted column property id.
public  voidsetSortDisabled(boolean sortDisabled)
     Disable sorting alltogether. To disable sorting alltogether, set to true.
public  voidsetVisibleColumns(Object[] visibleColumns)
     Set the array of visible column property id:s.
public  voidsort(Object[] propertyId, boolean[] ascending)
     Sort table.
public  voidsort()
     Sort table by currently selected sorting column.
public  voidvalueChange(Property.ValueChangeEvent event)
    

Field Detail
ALIGN_CENTER
final public static String ALIGN_CENTER(Code)
Center column alignment.



ALIGN_LEFT
final public static String ALIGN_LEFT(Code)
Left column alignment. This is the default behaviour.



ALIGN_RIGHT
final public static String ALIGN_RIGHT(Code)
Right column alignment.



COLUMN_HEADER_MODE_EXPLICIT
final public static int COLUMN_HEADER_MODE_EXPLICIT(Code)
Column header mode: Column headers are explicitly specified with setColumnHeaders()



COLUMN_HEADER_MODE_EXPLICIT_DEFAULTS_ID
final public static int COLUMN_HEADER_MODE_EXPLICIT_DEFAULTS_ID(Code)
Column header mode: Column headers are explicitly specified with setColumnHeaders()



COLUMN_HEADER_MODE_HIDDEN
final public static int COLUMN_HEADER_MODE_HIDDEN(Code)
Column header mode: Column headers are hidden. This is the default behaviour.



COLUMN_HEADER_MODE_ID
final public static int COLUMN_HEADER_MODE_ID(Code)
Column header mode: Property ID:s are used as column headers.



ROW_HEADER_MODE_EXPLICIT
final public static int ROW_HEADER_MODE_EXPLICIT(Code)
Row caption mode: Item captions are explicitly specified.



ROW_HEADER_MODE_EXPLICIT_DEFAULTS_ID
final public static int ROW_HEADER_MODE_EXPLICIT_DEFAULTS_ID(Code)
Row caption mode: Item captions are explicitly specified, but if the caption is missing, the item id objects toString() is used instead.



ROW_HEADER_MODE_HIDDEN
final public static int ROW_HEADER_MODE_HIDDEN(Code)
Row caption mode: The row headers are hidden. This is the default mode.



ROW_HEADER_MODE_ICON_ONLY
final public static int ROW_HEADER_MODE_ICON_ONLY(Code)
Row caption mode: Only icons are shown, the captions are hidden.



ROW_HEADER_MODE_ID
final public static int ROW_HEADER_MODE_ID(Code)
Row caption mode: Items Id-objects toString() is used as row caption.



ROW_HEADER_MODE_INDEX
final public static int ROW_HEADER_MODE_INDEX(Code)
Row caption mode: Index of the item is used as item caption. * The index mode can only be used with the containers implementing Container.Indexed interface.



ROW_HEADER_MODE_ITEM
final public static int ROW_HEADER_MODE_ITEM(Code)
Row caption mode: Item-objects toString() is used as row caption.



ROW_HEADER_MODE_PROPERTY
final public static int ROW_HEADER_MODE_PROPERTY(Code)
Row caption mode: Item captions are read from property specified with setItemCaptionPropertyId.




Constructor Detail
Table
public Table()(Code)
Create new empty table



Table
public Table(String caption)(Code)
Create new empty table with caption.



Table
public Table(String caption, Container dataSource)(Code)
Create new table with caption and connect it to a Container.




Method Detail
addActionHandler
public void addActionHandler(Action.Handler actionHandler)(Code)

See Also:   org.millstone.base.event.Action.Container.addActionHandler(Action.Handler)



addContainerProperty
public boolean addContainerProperty(Object propertyId, Class type, Object defaultValue) throws UnsupportedOperationException(Code)
Adds a new property to the table and show it as a visible column.
See Also:   org.millstone.base.data.Container.addContainerProperty(ObjectClassObject)
Parameters:
  propertyId - Id of the proprty
Parameters:
  type - The class of the property
Parameters:
  defaultValue - The default value given for all existing items



addContainerProperty
public boolean addContainerProperty(Object propertyId, Class type, Object defaultValue, String columnHeader, Resource columnIcon, String columnAlignment) throws UnsupportedOperationException(Code)
Adds a new property to the table and show it as a visible column.
See Also:   org.millstone.base.data.Container.addContainerProperty(ObjectClassObject)
Parameters:
  propertyId - Id of the proprty
Parameters:
  type - The class of the property
Parameters:
  defaultValue - The default value given for all existing items
Parameters:
  columnHeader - Explicit header of the column. If explicit header is notneeded, this should be set null.
Parameters:
  columnIcon - Icon of the column. If icon is not needed, this should be setnull.
Parameters:
  columnAlignment - Alignment of the column. Null implies align left.



addItem
public Object addItem(Object[] cells, Object itemId) throws UnsupportedOperationException(Code)
Add new row to table and fill the visible cells with given values.
Parameters:
  cells - Object array that is used for filling the visible cells newrow. The types must be settable to visible column propertytypes.
Parameters:
  itemId - Id the new row. If null, a new id is automatically assigned.If given, the table cant already have a item with given id. Returns item id for the new row. Returns null if operation fails.



addItemAfter
public Object addItemAfter(Object previousItemId) throws UnsupportedOperationException(Code)

See Also:   org.millstone.base.data.Container.Ordered.addItemAfter(java.lang.Object)



addItemAfter
public Item addItemAfter(Object previousItemId, Object newItemId) throws UnsupportedOperationException(Code)

See Also:   org.millstone.base.data.Container.Ordered.addItemAfter(java.lang.Objectjava.lang.Object)



attach
public void attach()(Code)

See Also:   org.millstone.base.ui.Component.attach



changeVariables
public void changeVariables(Object source, Map variables)(Code)
Invoked when the value of a variable has changed.
Parameters:
  event - Variable change event containing the information about thechanged variable.



containerItemSetChange
public void containerItemSetChange(Container.ItemSetChangeEvent event)(Code)
Container datasource item set change. Table must flush its buffers on change.
See Also:   org.millstone.base.data.Container.ItemSetChangeListener.containerItemSetChange(org.millstone.base.data.Container.ItemSetChangeEvent)



containerPropertySetChange
public void containerPropertySetChange(Container.PropertySetChangeEvent event)(Code)
Container datasource property set change. Table must flush its buffers on change.
See Also:   org.millstone.base.data.Container.PropertySetChangeListener.containerPropertySetChange(org.millstone.base.data.Container.PropertySetChangeEvent)



detach
public void detach()(Code)

See Also:   org.millstone.base.ui.Component.attach



firstItemId
public Object firstItemId()(Code)

See Also:   org.millstone.base.data.Container.Ordered.firstItemId



focus
public void focus() throws UnsupportedOperationException(Code)
Focusing to this component is not supported.
See Also:   org.millstone.base.ui.AbstractField.focus
throws:
  UnsupportedOperationException - if invoked.



formatPropertyValue
protected String formatPropertyValue(Object rowId, Object colId, Property property)(Code)
Formats table cell property values. By default the property.toString() and return a empty string for null properties.
Parameters:
  itemId -
Parameters:
  property - Property to be formatted String representation of property and its value.
since:
   3.1



getColumnAlignment
public String getColumnAlignment(Object propertyId)(Code)
Gets the specified column's alignment.
Parameters:
  propertyId - the propertyID identifying the column. the specified column's alignment if it as one; null otherwise.



getColumnAlignments
public String[] getColumnAlignments()(Code)
Get array of column alignments.

The items in the array must match the properties identified by getVisibleColumns(). The possible values for the alignments include:

  • ALIGN_LEFT: Left alignment
  • ALIGN_CENTER: Centered
  • ALIGN_RIGHT: Right alignment
The alignments default to ALIGN_LEFT: any null values are rendered as align lefts.

Column alignments array.



getColumnHeader
public String getColumnHeader(Object propertyId)(Code)
Gets the header for the specified column.
Parameters:
  propertyId - the propertyId indentifying the column. the header for the specifed column if it has one.



getColumnHeaderMode
public int getColumnHeaderMode()(Code)
Getter for property columnHeaderMode. Value of property columnHeaderMode.



getColumnHeaders
public String[] getColumnHeaders()(Code)
Get the headers of the columns.

The headers match the property id:s given my the set visible column headers. The table must be set in either ROW_HEADER_MODE_EXPLICIT or ROW_HEADER_MODE_EXPLICIT_DEFAULTS_ID mode to show the headers. In the defaults mode any nulls in the headers array are replaced with id.toString() outputs when rendering.

Array of column headers.



getColumnIcon
public Resource getColumnIcon(Object propertyId)(Code)
Gets the icon Resource for the specified column.
Parameters:
  propertyId - the propertyId indentifying the column. the icon for the specified column; null if the column has no iconset, or if the column is not visible.



getColumnIcons
public Resource[] getColumnIcons()(Code)
Get the icons of the columns.

The icons in headers match the property id:s given my the set visible column headers. The table must be set in either ROW_HEADER_MODE_EXPLICIT or ROW_HEADER_MODE_EXPLICIT_DEFAULTS_ID mode to show the headers with icons.

Array of icons that match the getVisibleColumns().



getCurrentPageFirstItemId
public Object getCurrentPageFirstItemId()(Code)
Getter for property currentPageFirstItem. Value of property currentPageFirstItem.



getCurrentPageFirstItemIndex
public int getCurrentPageFirstItemIndex()(Code)
Getter for property currentPageFirstItem. Value of property currentPageFirstItem.



getFieldFactory
public FieldFactory getFieldFactory()(Code)
Get the FieldFactory that is used to create editor for table cells. The FieldFactory is only used if the Table is editable.
See Also:   Table.isEditable FieldFactory used to create the Field instances.



getPageLength
public int getPageLength()(Code)
Get the page length.

Setting page length 0 disables paging.

Lenght of one page.



getPropertyValue
protected Object getPropertyValue(Object rowId, Object colId, Property property)(Code)
Get value of property. By default if the table is editable the fieldFactory is used to create editors for table cells. Otherwise formatPropertyValue is used to format the value representation.
See Also:   Table.setFieldFactory(FieldFactory)
Parameters:
  rowId - Id of the row (same as item Id)
Parameters:
  colId - Id of the column
Parameters:
  property - Property to be presented Object Either formatted value or Component for field.



getRowHeaderMode
public int getRowHeaderMode()(Code)
Get the row header mode. Row header mode.
See Also:   Table.setRowHeaderMode(int)



getSortContainerPropertyId
public Object getSortContainerPropertyId()(Code)
Get the currently sorted column property ID. Container property id of the currently sorted column.



getSortableContainerPropertyIds
public Collection getSortableContainerPropertyIds()(Code)



getTag
public String getTag()(Code)
Get UIDL tag corresponding to component. UIDL tag as string.



getVisibleColumns
public Object[] getVisibleColumns()(Code)
Get the array of visible column property id:s.

The columns are show in the order of their appearance in this array

Value of property availableColumns.



getVisibleItemIds
public Collection getVisibleItemIds()(Code)
Return list of items on the current page
See Also:   org.millstone.base.ui.Select.getVisibleItemIds



isColumnCollapsed
public boolean isColumnCollapsed(Object propertyId)(Code)
Checks if the specified column is collapsed.
Parameters:
  propertyId - the propertyID identifying the column. true if the column is collapsed; false otherwise;



isColumnCollapsingAllowed
public boolean isColumnCollapsingAllowed()(Code)
Check if column collapsing is allowed. true if columns can be collapsed; false otherwise.



isColumnReorderingAllowed
public boolean isColumnReorderingAllowed()(Code)
Check if column reordering is allowed. true if columns can be reordered; false otherwise.



isEditable
public boolean isEditable()(Code)
Is table editable. If table is editable a editor of type Field is created for each table cell. The assigned FieldFactory is used to create the instances. To provide custom editors for table cells create a class implementins the FieldFactory interface, and assign it to table, and set the editable property to true.
See Also:   Field
See Also:   FieldFactory true if table is editable, false oterwise.



isFirstId
public boolean isFirstId(Object itemId)(Code)

See Also:   org.millstone.base.data.Container.Ordered.isFirstId(java.lang.Object)



isLastId
public boolean isLastId(Object itemId)(Code)

See Also:   org.millstone.base.data.Container.Ordered.isLastId(java.lang.Object)



isPageBufferingEnabled
public boolean isPageBufferingEnabled()(Code)
Getter for property pageBuffering. Value of property pageBuffering.



isSelectable
public boolean isSelectable()(Code)
Getter for property selectable.

The table is not selectable by default.

Value of property selectable.



isSortAscending
public boolean isSortAscending()(Code)
Is the table currently sorted in ascending order. true if ascending, false ifdescending



isSortDisabled
public boolean isSortDisabled()(Code)
Is sorting disabled alltogether. True iff no sortable columns are given even in the case where datasource would support this. True iff sorting is disabled.



lastItemId
public Object lastItemId()(Code)

See Also:   org.millstone.base.data.Container.Ordered.lastItemId



nextItemId
public Object nextItemId(Object itemId)(Code)

See Also:   org.millstone.base.data.Container.Ordered.nextItemId(java.lang.Object)



paintContent
public void paintContent(PaintTarget target) throws PaintException(Code)
Paint the content of this component.
Parameters:
  target - Paint target.
throws:
  PaintException - The paint operation failed.



prevItemId
public Object prevItemId(Object itemId)(Code)

See Also:   org.millstone.base.data.Container.Ordered.prevItemId(java.lang.Object)



refreshCurrentPage
public void refreshCurrentPage()(Code)
Refresh the current page contents. If the page buffering is turned off, it is not necessary to call this explicitely.



removeActionHandler
public void removeActionHandler(Action.Handler actionHandler)(Code)

See Also:   org.millstone.base.event.Action.Container.removeActionHandler(Action.Handler)



removeAllItems
public boolean removeAllItems()(Code)

See Also:   org.millstone.base.data.Container.removeAllItems



removeContainerProperty
public boolean removeContainerProperty(Object propertyId) throws UnsupportedOperationException(Code)

See Also:   org.millstone.base.data.Container.removeContainerProperty(Object)



removeItem
public boolean removeItem(Object itemId)(Code)

See Also:   org.millstone.base.data.Container.removeItem(Object)



setColumnAlignment
public void setColumnAlignment(Object propertyId, String alignment)(Code)
Sets the specified column's alignment.

Throws IllegalArgumentException if the alignment is not one of the following: ALIGN_LEFT, ALIGN_CENTER or ALIGN_RIGHT


Parameters:
  propertyId - the propertyID identifying the column.
Parameters:
  alignment - the desired alignment.



setColumnAlignments
public void setColumnAlignments(String[] columnAlignments)(Code)
Set the column alignments.

The items in the array must match the properties identified by getVisibleColumns(). The possible values for the alignments include:

  • ALIGN_LEFT: Left alignment
  • ALIGN_CENTER: Centered
  • ALIGN_RIGHT: Right alignment
The alignments default to ALIGN_LEFT


Parameters:
  columnAlignments - Column alignments array.



setColumnCollapsed
public void setColumnCollapsed(Object propertyId, boolean collapsed) throws IllegalAccessException(Code)
Sets whether the specified column is collapsed or not.
Parameters:
  propertyId - the propertyID identifying the column.
Parameters:
  collapsed - the desired collapsedness.



setColumnCollapsingAllowed
public void setColumnCollapsingAllowed(boolean collapsingAllowed)(Code)
Sets whether column collapsing is allowed or not.
Parameters:
  collapsingAllowed - specifies whether column collapsing is allowed.



setColumnHeader
public void setColumnHeader(Object propertyId, String header)(Code)
Sets column header for the specified column;
Parameters:
  propertyId - the propertyId indentifying the column.
Parameters:
  header - the header to set.



setColumnHeaderMode
public void setColumnHeaderMode(int columnHeaderMode)(Code)
Setter for property columnHeaderMode.
Parameters:
  columnHeaderMode - New value of property columnHeaderMode.



setColumnHeaders
public void setColumnHeaders(String[] columnHeaders)(Code)
Set the headers of the columns.

The headers match the property id:s given my the set visible column headers. The table must be set in either ROW_HEADER_MODE_EXPLICIT or ROW_HEADER_MODE_EXPLICIT_DEFAULTS_ID mode to show the headers. In the defaults mode any nulls in the headers array are replaced with id.toString() outputs when rendering.


Parameters:
  columnHeaders - Array of column headers that match thegetVisibleColumns().



setColumnIcon
public void setColumnIcon(Object propertyId, Resource icon)(Code)
Sets the icon Resource for the specified column.

Throws IllegalArgumentException if the specified column is not visible.


Parameters:
  propertyId - the propertyId identifying the column.
Parameters:
  icon - the icon Resource to set.



setColumnIcons
public void setColumnIcons(Resource[] columnIcons)(Code)
Set the icons of the columns.

The icons in headers match the property id:s given my the set visible column headers. The table must be set in either ROW_HEADER_MODE_EXPLICIT or ROW_HEADER_MODE_EXPLICIT_DEFAULTS_ID mode to show the headers with icons.


Parameters:
  columnIcons - Array of icons that match the getVisibleColumns().



setColumnReorderingAllowed
public void setColumnReorderingAllowed(boolean reorderingAllowed)(Code)
Sets whether column reordering is allowed or not.
Parameters:
  reorderingAllowed - specifies whether column reordering is allowed.



setContainerDataSource
public void setContainerDataSource(Container newDataSource)(Code)

See Also:   org.millstone.base.data.Container.Viewer.setContainerDataSource(Container)



setCurrentPageFirstItemId
public void setCurrentPageFirstItemId(Object currentPageFirstItemId)(Code)
Setter for property currentPageFirstItem.
Parameters:
  currentPageFirstItem - New value of property currentPageFirstItem.



setCurrentPageFirstItemIndex
public void setCurrentPageFirstItemIndex(int newIndex)(Code)
Setter for property currentPageFirstItem.
Parameters:
  newIndex - New value of property currentPageFirstItem.



setEditable
public void setEditable(boolean editable)(Code)
Set the editable property. If table is editable a editor of type Field is created for each table cell. The assigned FieldFactory is used to create the instances. To provide custom editors for table cells create a class implementins the FieldFactory interface, and assign it to table, and set the editable property to true.
See Also:   Field
See Also:   FieldFactory
Parameters:
  editable - true if table should be editable by user.



setFieldFactory
public void setFieldFactory(FieldFactory fieldFactory)(Code)
Set the FieldFactory that is used to create editor for table cells. The FieldFactory is only used if the Table is editable. By default the BaseFieldFactory is used.
See Also:   Table.isEditable
See Also:   BaseFieldFactory
Parameters:
  fieldFactory - The field factory to set



setNewItemsAllowed
public void setNewItemsAllowed(boolean allowNewOptions) throws UnsupportedOperationException(Code)
Adding new items is not supported.
See Also:   org.millstone.base.ui.Select.setNewItemsAllowed(boolean)
throws:
  UnsupportedOperationException - if set to true.



setPageBufferingEnabled
public void setPageBufferingEnabled(boolean pageBuffering)(Code)
Setter for property pageBuffering.
Parameters:
  pageBuffering - New value of property pageBuffering.



setPageLength
public void setPageLength(int pageLength)(Code)
Set the page length.

Setting page length 0 disables paging. The page length defaults to 0 (no paging).


Parameters:
  Lenght - of one page.



setRowHeaderMode
public void setRowHeaderMode(int mode)(Code)
Set the row header mode.

The mode can be one of the following ones:

  • ROW_HEADER_MODE_HIDDEN: The row captions are hidden.
  • ROW_HEADER_MODE_ID: Items Id-objects toString() is used as row caption.
  • ROW_HEADER_MODE_ITEM: Item-objects toString() is used as row caption.
  • ROW_HEADER_MODE_PROPERTY: Property set with setItemCaptionPropertyId() is used as row header.
  • ROW_HEADER_MODE_EXPLICIT_DEFAULTS_ID: Items Id-objects toString() is used as row header. If caption is explicitly specified, it overrides the id-caption.
  • ROW_HEADER_MODE_EXPLICIT: The row headers must be explicitly specified.
  • ROW_HEADER_MODE_INDEX: The index of the item is used as row caption. The index mode can only be used with the containers implementing Container.Indexed interface.
The default value is ROW_HEADER_MODE_HIDDEN


Parameters:
  mode - One of the modes listed above.



setSelectable
public void setSelectable(boolean selectable)(Code)
Setter for property selectable.

The table is not selectable by default.


Parameters:
  selectable - New value of property selectable.



setSortAscending
public void setSortAscending(boolean ascending)(Code)
Set the table in ascending order.
Parameters:
  ascending - true if ascending, false ifdescending



setSortContainerPropertyId
public void setSortContainerPropertyId(Object propertyId)(Code)
Set the currently sorted column property id.
Parameters:
  propertyId - Container property id of the currently sorted column.



setSortDisabled
public void setSortDisabled(boolean sortDisabled)(Code)
Disable sorting alltogether. To disable sorting alltogether, set to true. In this case no sortable columns are given even in the case where datasource would support this.
Parameters:
  sortDisabled - True iff sorting is disabled



setVisibleColumns
public void setVisibleColumns(Object[] visibleColumns)(Code)
Set the array of visible column property id:s.

The columns are show in the order of their appearance in this array


Parameters:
  availableColumns - Array of shown property id:s.



sort
public void sort(Object[] propertyId, boolean[] ascending) throws UnsupportedOperationException(Code)
Sort table.
See Also:   org.millstone.base.data.Container.Sortable.sort(java.lang.Object[]boolean[])
throws:
  UnsupportedOperationException - if the container data source does not implementContainer.Sortable



sort
public void sort()(Code)
Sort table by currently selected sorting column.
throws:
  UnsupportedOperationException - if the container data source does not implementContainer.Sortable



valueChange
public void valueChange(Property.ValueChangeEvent event)(Code)

See Also:   org.millstone.base.data.Property.ValueChangeListener.valueChange(Property.ValueChangeEvent)



Fields inherited from org.millstone.base.ui.Select
final public static int ITEM_CAPTION_MODE_EXPLICIT(Code)(Java Doc)
final public static int ITEM_CAPTION_MODE_EXPLICIT_DEFAULTS_ID(Code)(Java Doc)
final public static int ITEM_CAPTION_MODE_ICON_ONLY(Code)(Java Doc)
final public static int ITEM_CAPTION_MODE_ID(Code)(Java Doc)
final public static int ITEM_CAPTION_MODE_INDEX(Code)(Java Doc)
final public static int ITEM_CAPTION_MODE_ITEM(Code)(Java Doc)
final public static int ITEM_CAPTION_MODE_PROPERTY(Code)(Java Doc)
protected KeyMapper itemIdMapper(Code)(Java Doc)
protected Container items(Code)(Java Doc)

Methods inherited from org.millstone.base.ui.Select
public boolean addContainerProperty(Object propertyId, Class type, Object defaultValue) throws UnsupportedOperationException(Code)(Java Doc)
public Object addItem() throws UnsupportedOperationException(Code)(Java Doc)
public Item addItem(Object itemId) throws UnsupportedOperationException(Code)(Java Doc)
public void addListener(Container.PropertySetChangeListener listener)(Code)(Java Doc)
public void addListener(Container.ItemSetChangeListener listener)(Code)(Java Doc)
public void changeVariables(Object source, Map variables)(Code)(Java Doc)
public void containerItemSetChange(Container.ItemSetChangeEvent event)(Code)(Java Doc)
public void containerPropertySetChange(Container.PropertySetChangeEvent event)(Code)(Java Doc)
public boolean containsId(Object itemId)(Code)(Java Doc)
protected void fireItemSetChange()(Code)(Java Doc)
protected void firePropertySetChange()(Code)(Java Doc)
public Container getContainerDataSource()(Code)(Java Doc)
public Property getContainerProperty(Object itemId, Object propertyId)(Code)(Java Doc)
public Collection getContainerPropertyIds()(Code)(Java Doc)
public Item getItem(Object itemId)(Code)(Java Doc)
public String getItemCaption(Object itemId)(Code)(Java Doc)
public int getItemCaptionMode()(Code)(Java Doc)
public Object getItemCaptionPropertyId()(Code)(Java Doc)
public Resource getItemIcon(Object itemId)(Code)(Java Doc)
public Object getItemIconPropertyId()(Code)(Java Doc)
public Collection getItemIds()(Code)(Java Doc)
final public Object getNullSelectionItemId()(Code)(Java Doc)
public String getTag()(Code)(Java Doc)
public Class getType()(Code)(Java Doc)
public Class getType(Object propertyId)(Code)(Java Doc)
public Object getValue()(Code)(Java Doc)
public Collection getVisibleItemIds()(Code)(Java Doc)
public boolean isMultiSelect()(Code)(Java Doc)
public boolean isNewItemsAllowed()(Code)(Java Doc)
public boolean isSelected(Object itemId)(Code)(Java Doc)
public void paintContent(PaintTarget target) throws PaintException(Code)(Java Doc)
public boolean removeAllItems() throws UnsupportedOperationException(Code)(Java Doc)
public boolean removeContainerProperty(Object propertyId) throws UnsupportedOperationException(Code)(Java Doc)
public boolean removeItem(Object itemId) throws UnsupportedOperationException(Code)(Java Doc)
public void removeListener(Container.PropertySetChangeListener listener)(Code)(Java Doc)
public void removeListener(Container.ItemSetChangeListener listener)(Code)(Java Doc)
public void select(Object itemId)(Code)(Java Doc)
public void setContainerDataSource(Container newDataSource)(Code)(Java Doc)
public void setItemCaption(Object itemId, String caption)(Code)(Java Doc)
public void setItemCaptionMode(int mode)(Code)(Java Doc)
public void setItemCaptionPropertyId(Object propertyId)(Code)(Java Doc)
public void setItemIcon(Object itemId, Resource icon)(Code)(Java Doc)
public void setItemIconPropertyId(Object propertyId)(Code)(Java Doc)
public void setMultiSelect(boolean multiSelect)(Code)(Java Doc)
public void setNewItemsAllowed(boolean allowNewOptions)(Code)(Java Doc)
public void setNullSelectionItemId(Object nullSelectionItemId)(Code)(Java Doc)
public void setValue(Object newValue) throws Property.ReadOnlyException, Property.ConversionException(Code)(Java Doc)
public int size()(Code)(Java Doc)
public void unselect(Object itemId)(Code)(Java Doc)

Methods inherited from org.millstone.base.ui.AbstractField
public void addListener(Property.ValueChangeListener listener)(Code)(Java Doc)
public void addListener(Property.ReadOnlyStatusChangeListener listener)(Code)(Java Doc)
public void addValidator(Validator validator)(Code)(Java Doc)
public void attach()(Code)(Java Doc)
public void commit() throws Buffered.SourceException(Code)(Java Doc)
public static AbstractField constructField(Class propertyType)(Code)(Java Doc)
public void discard() throws Buffered.SourceException(Code)(Java Doc)
public void finalize() throws Throwable(Code)(Java Doc)
protected void fireReadOnlyStatusChange()(Code)(Java Doc)
protected void fireValueChange()(Code)(Java Doc)
public void focus()(Code)(Java Doc)
public ErrorMessage getErrorMessage()(Code)(Java Doc)
public long getFocusableId()(Code)(Java Doc)
public Property getPropertyDataSource()(Code)(Java Doc)
public int getTabIndex()(Code)(Java Doc)
abstract public Class getType()(Code)(Java Doc)
public Collection getValidators()(Code)(Java Doc)
public Object getValue()(Code)(Java Doc)
public boolean isInvalidAllowed()(Code)(Java Doc)
public boolean isInvalidCommitted()(Code)(Java Doc)
public boolean isModified()(Code)(Java Doc)
public boolean isReadOnly()(Code)(Java Doc)
public boolean isReadThrough()(Code)(Java Doc)
public boolean isRequired()(Code)(Java Doc)
public boolean isValid()(Code)(Java Doc)
public boolean isWriteThrough()(Code)(Java Doc)
public void paintContent(PaintTarget target) throws PaintException(Code)(Java Doc)
public void removeListener(Property.ValueChangeListener listener)(Code)(Java Doc)
public void removeListener(Property.ReadOnlyStatusChangeListener listener)(Code)(Java Doc)
public void removeValidator(Validator validator)(Code)(Java Doc)
protected void setInternalValue(Object newValue)(Code)(Java Doc)
public void setInvalidAllowed(boolean invalidAllowed) throws UnsupportedOperationException(Code)(Java Doc)
public void setInvalidCommitted(boolean isCommitted)(Code)(Java Doc)
public void setPropertyDataSource(Property newDataSource)(Code)(Java Doc)
public void setReadOnly(boolean readOnly)(Code)(Java Doc)
public void setReadThrough(boolean readTrough) throws Buffered.SourceException(Code)(Java Doc)
public void setRequired(boolean required)(Code)(Java Doc)
public void setTabIndex(int tabIndex)(Code)(Java Doc)
public void setValue(Object newValue) throws Property.ReadOnlyException, Property.ConversionException(Code)(Java Doc)
public void setWriteThrough(boolean writeTrough) throws Buffered.SourceException(Code)(Java Doc)
public String toString()(Code)(Java Doc)
public void validate() throws Validator.InvalidValueException(Code)(Java Doc)
public void valueChange(Property.ValueChangeEvent event)(Code)(Java Doc)

Methods inherited from org.millstone.base.ui.AbstractComponent
public void addListener(RepaintRequestListener listener)(Code)(Java Doc)
public void addListener(Class eventType, Object object, Method method)(Code)(Java Doc)
public void addListener(Class eventType, Object object, String methodName)(Code)(Java Doc)
public void addListener(Component.Listener listener)(Code)(Java Doc)
public void attach()(Code)(Java Doc)
public void changeVariables(Object source, Map variables)(Code)(Java Doc)
public void childRequestedRepaint(Collection alreadyNotified)(Code)(Java Doc)
public void dependsOn(VariableOwner depended)(Code)(Java Doc)
public void detach()(Code)(Java Doc)
protected void fireComponentErrorEvent()(Code)(Java Doc)
protected void fireComponentEvent()(Code)(Java Doc)
protected void fireEvent(Component.Event event)(Code)(Java Doc)
public Application getApplication()(Code)(Java Doc)
public String getCaption()(Code)(Java Doc)
public ErrorMessage getComponentError()(Code)(Java Doc)
public Object getData()(Code)(Java Doc)
public String getDescription()(Code)(Java Doc)
public Set getDirectDependencies()(Code)(Java Doc)
public ErrorMessage getErrorMessage()(Code)(Java Doc)
public Resource getIcon()(Code)(Java Doc)
public Locale getLocale()(Code)(Java Doc)
public Component getParent()(Code)(Java Doc)
public String getStyle()(Code)(Java Doc)
abstract public String getTag()(Code)(Java Doc)
public Window getWindow()(Code)(Java Doc)
public boolean isEnabled()(Code)(Java Doc)
public boolean isImmediate()(Code)(Java Doc)
public boolean isReadOnly()(Code)(Java Doc)
public boolean isVisible()(Code)(Java Doc)
final public void paint(PaintTarget target) throws PaintException(Code)(Java Doc)
public void paintContent(PaintTarget target) throws PaintException(Code)(Java Doc)
public void removeDirectDependency(VariableOwner depended)(Code)(Java Doc)
public void removeListener(RepaintRequestListener listener)(Code)(Java Doc)
public void removeListener(Class eventType, Object target)(Code)(Java Doc)
public void removeListener(Class eventType, Object target, Method method)(Code)(Java Doc)
public void removeListener(Class eventType, Object target, String methodName)(Code)(Java Doc)
public void removeListener(Component.Listener listener)(Code)(Java Doc)
public void requestRepaint()(Code)(Java Doc)
public void requestRepaintRequests()(Code)(Java Doc)
public void setCaption(String caption)(Code)(Java Doc)
public void setComponentError(ErrorMessage componentError)(Code)(Java Doc)
public void setData(Object data)(Code)(Java Doc)
public void setDescription(String description)(Code)(Java Doc)
public void setEnabled(boolean enabled)(Code)(Java Doc)
public void setIcon(Resource icon)(Code)(Java Doc)
public void setImmediate(boolean immediate)(Code)(Java Doc)
public void setLocale(Locale locale)(Code)(Java Doc)
public void setParent(Component parent)(Code)(Java Doc)
public void setReadOnly(boolean readOnly)(Code)(Java Doc)
public void setStyle(String style)(Code)(Java Doc)
public void setVisible(boolean visible)(Code)(Java Doc)

Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.