it = visibleColumns.iterator(); it.hasNext();) {
Object id = it.next();
if (!columnGenerators.containsKey(id)) {
availableCols.add(id);
}
}
// Checks that a correct number of cells are given
if (cells.length != availableCols.size()) {
return null;
}
// Creates new item
Item item;
if (itemId == null) {
itemId = items.addItem();
if (itemId == null) {
return null;
}
item = items.getItem(itemId);
} else {
item = items.addItem(itemId);
}
if (item == null) {
return null;
}
// Fills the item properties
for (int i = 0; i < availableCols.size(); i++) {
item.getItemProperty(availableCols.get(i)).setValue(cells[i]);
}
if (!(items instanceof Container.ItemSetChangeNotifier)) {
refreshRowCache();
}
return itemId;
}
/**
* Discards and recreates the internal row cache. Call this if you make
* changes that affect the rows but the information about the changes are
* not automatically propagated to the Table.
*
* Do not call this e.g. if you have updated the data model through a
* Property. These types of changes are automatically propagated to the
* Table.
*
* A typical case when this is needed is if you update a generator (e.g.
* CellStyleGenerator) and want to ensure that the rows are redrawn with new
* styles.
*
* Note that calling this method is not cheap so avoid calling it
* unnecessarily.
*
* @since 6.7.2
*/
public void refreshRowCache() {
resetPageBuffer();
refreshRenderedCells();
}
/**
* Sets the Container that serves as the data source of the viewer. As a
* side-effect the table's selection value is set to null as the old
* selection might not exist in new Container. generated;
if (columnGenerators != null) {
generated = columnGenerators.keySet();
} else {
generated = Collections.emptyList();
}
List visibleIds = new ArrayList();
if (generated.isEmpty()) {
visibleIds.addAll(newDataSource.getContainerPropertyIds());
} else {
for (Object id : newDataSource.getContainerPropertyIds()) {
// don't add duplicates
if (!generated.contains(id)) {
visibleIds.add(id);
}
}
// generated columns to the end
visibleIds.addAll(generated);
}
setContainerDataSource(newDataSource, visibleIds);
}
/**
* Sets the container data source and the columns that will be visible.
* Columns are shown in the collection's iteration order.
*
* @see Table#setContainerDataSource(Container)
* @see Table#setVisibleColumns(Object[])
*
* @param newDataSource
* the new data source.
* @param visibleIds
* IDs of the visible columns
*/
public void setContainerDataSource(Container newDataSource,
Collection visibleIds) {
disableContentRefreshing();
if (newDataSource == null) {
newDataSource = new IndexedContainer();
}
if (visibleIds == null) {
visibleIds = new ArrayList();
}
// Assures that the data source is ordered by making unordered
// containers ordered by wrapping them
if (newDataSource instanceof Container.Ordered) {
super.setContainerDataSource(newDataSource);
} else {
super.setContainerDataSource(new ContainerOrderedWrapper(
newDataSource));
}
// Resets page position
currentPageFirstItemId = null;
currentPageFirstItemIndex = 0;
// Resets column properties
if (collapsedColumns != null) {
collapsedColumns.clear();
}
// don't add the same id twice
Collection col = new LinkedList();
for (Iterator it = visibleIds.iterator(); it.hasNext();) {
Object id = it.next();
if (!col.contains(id)) {
col.add(id);
}
}
setVisibleColumns(col.toArray());
// Assure visual refresh
resetPageBuffer();
enableContentRefreshing(true);
}
/**
* Gets items ids from a range of key values
*
* @param startRowKey
* The start key
* @param endRowKey
* The end key
* @return
*/
private LinkedHashSet getItemIdsInRange(Object itemId,
final int length) {
LinkedHashSet ids = new LinkedHashSet();
for (int i = 0; i < length; i++) {
assert itemId != null; // should not be null unless client-server
// are out of sync
ids.add(itemId);
itemId = nextItemId(itemId);
}
return ids;
}
/**
* Handles selection if selection is a multiselection
*
* @param variables
* The variables
*/
private void handleSelectedItems(Map variables) {
final String[] ka = (String[]) variables.get("selected");
final String[] ranges = (String[]) variables.get("selectedRanges");
Set renderedButNotSelectedItemIds = getCurrentlyRenderedItemIds();
@SuppressWarnings("unchecked")
HashSet newValue = new LinkedHashSet(
(Collection) getValue());
if (variables.containsKey("clearSelections")) {
// the client side has instructed to swipe all previous selections
newValue.clear();
}
/*
* Then add (possibly some of them back) rows that are currently
* selected on the client side (the ones that the client side is aware
* of).
*/
for (int i = 0; i < ka.length; i++) {
// key to id
final Object id = itemIdMapper.get(ka[i]);
if (!isNullSelectionAllowed()
&& (id == null || id == getNullSelectionItemId())) {
// skip empty selection if nullselection is not allowed
markAsDirty();
} else if (id != null && containsId(id)) {
newValue.add(id);
renderedButNotSelectedItemIds.remove(id);
}
}
/* Add range items aka shift clicked multiselection areas */
if (ranges != null) {
for (String range : ranges) {
String[] split = range.split("-");
Object startItemId = itemIdMapper.get(split[0]);
int length = Integer.valueOf(split[1]);
LinkedHashSet itemIdsInRange = getItemIdsInRange(
startItemId, length);
newValue.addAll(itemIdsInRange);
renderedButNotSelectedItemIds.removeAll(itemIdsInRange);
}
}
/*
* finally clear all currently rendered rows (the ones that the client
* side counterpart is aware of) that the client didn't send as selected
*/
newValue.removeAll(renderedButNotSelectedItemIds);
if (!isNullSelectionAllowed() && newValue.isEmpty()) {
// empty selection not allowed, keep old value
markAsDirty();
return;
}
setValue(newValue, true);
}
private Set getCurrentlyRenderedItemIds() {
HashSet ids = new HashSet();
if (pageBuffer != null) {
for (int i = 0; i < pageBuffer[CELL_ITEMID].length; i++) {
ids.add(pageBuffer[CELL_ITEMID][i]);
}
}
return ids;
}
/* Component basics */
/**
* Invoked when the value of a variable has changed.
*
* @see com.vaadin.ui.Select#changeVariables(java.lang.Object,
* java.util.Map)
*/
@Override
public void changeVariables(Object source, Map variables) {
boolean clientNeedsContentRefresh = false;
handleClickEvent(variables);
handleColumnResizeEvent(variables);
handleColumnWidthUpdates(variables);
disableContentRefreshing();
if (!isSelectable() && variables.containsKey("selected")) {
// Not-selectable is a special case, AbstractSelect does not support
// TODO could be optimized.
variables = new HashMap(variables);
variables.remove("selected");
}
/*
* The AbstractSelect cannot handle the multiselection properly, instead
* we handle it ourself
*/
else if (isSelectable() && isMultiSelect()
&& variables.containsKey("selected")
&& multiSelectMode == MultiSelectMode.DEFAULT) {
handleSelectedItems(variables);
variables = new HashMap(variables);
variables.remove("selected");
}
super.changeVariables(source, variables);
// Client might update the pagelength if Table height is fixed
if (variables.containsKey("pagelength")) {
// Sets pageLength directly to avoid repaint that setter causes
pageLength = (Integer) variables.get("pagelength");
}
// Page start index
if (variables.containsKey("firstvisible")) {
final Integer value = (Integer) variables.get("firstvisible");
if (value != null) {
setCurrentPageFirstItemIndex(value.intValue(), false);
}
}
// Sets requested firstrow and rows for the next paint
if (variables.containsKey("reqfirstrow")
|| variables.containsKey("reqrows")) {
try {
firstToBeRenderedInClient = ((Integer) variables
.get("firstToBeRendered")).intValue();
lastToBeRenderedInClient = ((Integer) variables
.get("lastToBeRendered")).intValue();
} catch (Exception e) {
// FIXME: Handle exception
getLogger().log(Level.FINER,
"Could not parse the first and/or last rows.", e);
}
// respect suggested rows only if table is not otherwise updated
// (row caches emptied by other event)
if (!containerChangeToBeRendered) {
Integer value = (Integer) variables.get("reqfirstrow");
if (value != null) {
reqFirstRowToPaint = value.intValue();
}
value = (Integer) variables.get("reqrows");
if (value != null) {
reqRowsToPaint = value.intValue();
// sanity check
if (reqFirstRowToPaint + reqRowsToPaint > size()) {
reqRowsToPaint = size() - reqFirstRowToPaint;
}
}
}
if (getLogger().isLoggable(Level.FINEST)) {
getLogger().log(
Level.FINEST,
"Client wants rows {0}-{1}",
new Object[] { reqFirstRowToPaint,
(reqFirstRowToPaint + reqRowsToPaint - 1) });
}
clientNeedsContentRefresh = true;
}
if (isSortEnabled()) {
// Sorting
boolean doSort = false;
if (variables.containsKey("sortcolumn")) {
final String colId = (String) variables.get("sortcolumn");
if (colId != null && !"".equals(colId) && !"null".equals(colId)) {
final Object id = columnIdMap.get(colId);
setSortContainerPropertyId(id, false);
doSort = true;
}
}
if (variables.containsKey("sortascending")) {
final boolean state = ((Boolean) variables.get("sortascending"))
.booleanValue();
if (state != sortAscending) {
setSortAscending(state, false);
doSort = true;
}
}
if (doSort) {
this.sort();
resetPageBuffer();
}
}
// Dynamic column hide/show and order
// Update visible columns
if (isColumnCollapsingAllowed()) {
if (variables.containsKey("collapsedcolumns")) {
try {
final Object[] ids = (Object[]) variables
.get("collapsedcolumns");
Set idSet = new HashSet();
for (Object id : ids) {
idSet.add(columnIdMap.get(id.toString()));
}
for (final Iterator it = visibleColumns.iterator(); it
.hasNext();) {
Object propertyId = it.next();
if (isColumnCollapsed(propertyId)) {
if (!idSet.contains(propertyId)) {
setColumnCollapsed(propertyId, false);
}
} else if (idSet.contains(propertyId)) {
setColumnCollapsed(propertyId, true);
}
}
} catch (final Exception e) {
// FIXME: Handle exception
getLogger().log(Level.FINER,
"Could not determine column collapsing state", e);
}
clientNeedsContentRefresh = true;
}
}
if (isColumnReorderingAllowed()) {
if (variables.containsKey("columnorder")) {
try {
final Object[] ids = (Object[]) variables
.get("columnorder");
// need a real Object[], ids can be a String[]
final Object[] idsTemp = new Object[ids.length];
for (int i = 0; i < ids.length; i++) {
idsTemp[i] = columnIdMap.get(ids[i].toString());
}
setColumnOrder(idsTemp);
if (hasListeners(ColumnReorderEvent.class)) {
fireEvent(new ColumnReorderEvent(this));
}
} catch (final Exception e) {
// FIXME: Handle exception
getLogger().log(Level.FINER,
"Could not determine column reordering state", e);
}
clientNeedsContentRefresh = true;
}
}
enableContentRefreshing(clientNeedsContentRefresh);
// Actions
if (variables.containsKey("action")) {
final StringTokenizer st = new StringTokenizer(
(String) variables.get("action"), ",");
if (st.countTokens() == 2) {
final Object itemId = itemIdMapper.get(st.nextToken());
final Action action = actionMapper.get(st.nextToken());
if (action != null && (itemId == null || containsId(itemId))
&& actionHandlers != null) {
for (Handler ah : actionHandlers) {
ah.handleAction(action, this, itemId);
}
}
}
}
}
/**
* Handles click event
*
* @param variables
*/
private void handleClickEvent(Map variables) {
// Item click event
if (variables.containsKey("clickEvent")) {
String key = (String) variables.get("clickedKey");
Object itemId = itemIdMapper.get(key);
Object propertyId = null;
String colkey = (String) variables.get("clickedColKey");
// click is not necessary on a property
if (colkey != null) {
propertyId = columnIdMap.get(colkey);
}
MouseEventDetails evt = MouseEventDetails
.deSerialize((String) variables.get("clickEvent"));
Item item = getItem(itemId);
if (item != null) {
fireEvent(new ItemClickEvent(this, item, itemId, propertyId,
evt));
}
}
// Header click event
else if (variables.containsKey("headerClickEvent")) {
MouseEventDetails details = MouseEventDetails
.deSerialize((String) variables.get("headerClickEvent"));
Object cid = variables.get("headerClickCID");
Object propertyId = null;
if (cid != null) {
propertyId = columnIdMap.get(cid.toString());
}
fireEvent(new HeaderClickEvent(this, propertyId, details));
}
// Footer click event
else if (variables.containsKey("footerClickEvent")) {
MouseEventDetails details = MouseEventDetails
.deSerialize((String) variables.get("footerClickEvent"));
Object cid = variables.get("footerClickCID");
Object propertyId = null;
if (cid != null) {
propertyId = columnIdMap.get(cid.toString());
}
fireEvent(new FooterClickEvent(this, propertyId, details));
}
}
/**
* Handles the column resize event sent by the client.
*
* @param variables
*/
private void handleColumnResizeEvent(Map variables) {
if (variables.containsKey("columnResizeEventColumn")) {
Object cid = variables.get("columnResizeEventColumn");
Object propertyId = null;
if (cid != null) {
propertyId = columnIdMap.get(cid.toString());
Object prev = variables.get("columnResizeEventPrev");
int previousWidth = -1;
if (prev != null) {
previousWidth = Integer.valueOf(prev.toString());
}
Object curr = variables.get("columnResizeEventCurr");
int currentWidth = -1;
if (curr != null) {
currentWidth = Integer.valueOf(curr.toString());
}
fireColumnResizeEvent(propertyId, previousWidth, currentWidth);
}
}
}
private void fireColumnResizeEvent(Object propertyId, int previousWidth,
int currentWidth) {
/*
* Update the sizes on the server side. If a column previously had a
* expand ratio and the user resized the column then the expand ratio
* will be turned into a static pixel size.
*/
setColumnWidth(propertyId, currentWidth);
fireEvent(new ColumnResizeEvent(this, propertyId, previousWidth,
currentWidth));
}
private void handleColumnWidthUpdates(Map variables) {
if (variables.containsKey("columnWidthUpdates")) {
String[] events = (String[]) variables.get("columnWidthUpdates");
for (String str : events) {
String[] eventDetails = str.split(":");
Object propertyId = columnIdMap.get(eventDetails[0]);
if (propertyId == null) {
propertyId = ROW_HEADER_FAKE_PROPERTY_ID;
}
int width = Integer.valueOf(eventDetails[1]);
setColumnWidth(propertyId, width);
}
}
}
/**
* Go to mode where content updates are not done. This is due we want to
* bypass expensive content for some reason (like when we know we may have
* other content changes on their way).
*
* @return true if content refresh flag was enabled prior this call
*/
protected boolean disableContentRefreshing() {
boolean wasDisabled = isContentRefreshesEnabled;
isContentRefreshesEnabled = false;
return wasDisabled;
}
/**
* Go to mode where content content refreshing has effect.
*
* @param refreshContent
* true if content refresh needs to be done
*/
protected void enableContentRefreshing(boolean refreshContent) {
isContentRefreshesEnabled = true;
if (refreshContent) {
refreshRenderedCells();
// Ensure that client gets a response
markAsDirty();
}
}
@Override
public void beforeClientResponse(boolean initial) {
super.beforeClientResponse(initial);
// Ensure pageBuffer is filled before sending the response to avoid
// calls to markAsDirty during paint
getVisibleCells();
}
/*
* (non-Javadoc)
*
* @see com.vaadin.ui.AbstractSelect#paintContent(com.vaadin.
* terminal.PaintTarget)
*/
@Override
public void paintContent(PaintTarget target) throws PaintException {
isBeingPainted = true;
try {
doPaintContent(target);
} finally {
isBeingPainted = false;
}
}
private void doPaintContent(PaintTarget target) throws PaintException {
/*
* Body actions - Actions which has the target null and can be invoked
* by right clicking on the table body.
*/
final Set actionSet = findAndPaintBodyActions(target);
final Object[][] cells = getVisibleCells();
int rows = findNumRowsToPaint(target, cells);
int total = size();
if (shouldHideNullSelectionItem()) {
total--;
rows--;
}
// Table attributes
paintTableAttributes(target, rows, total);
paintVisibleColumnOrder(target);
// Rows
if (isPartialRowUpdate() && painted && !target.isFullRepaint()) {
paintPartialRowUpdate(target, actionSet);
} else if (target.isFullRepaint() || isRowCacheInvalidated()) {
paintRows(target, cells, actionSet);
setRowCacheInvalidated(false);
}
/*
* Send the page buffer indexes to ensure that the client side stays in
* sync. Otherwise we _might_ have the situation where the client side
* discards too few or too many rows, causing out of sync issues.
*/
int pageBufferLastIndex = pageBufferFirstIndex
+ pageBuffer[CELL_ITEMID].length - 1;
target.addAttribute(TableConstants.ATTRIBUTE_PAGEBUFFER_FIRST,
pageBufferFirstIndex);
target.addAttribute(TableConstants.ATTRIBUTE_PAGEBUFFER_LAST,
pageBufferLastIndex);
paintSorting(target);
resetVariablesAndPageBuffer(target);
// Actions
paintActions(target, actionSet);
paintColumnOrder(target);
// Available columns
paintAvailableColumns(target);
paintVisibleColumns(target);
if (keyMapperReset) {
keyMapperReset = false;
target.addAttribute(TableConstants.ATTRIBUTE_KEY_MAPPER_RESET, true);
}
if (dropHandler != null) {
dropHandler.getAcceptCriterion().paint(target);
}
painted = true;
}
private void setRowCacheInvalidated(boolean invalidated) {
rowCacheInvalidated = invalidated;
}
protected boolean isRowCacheInvalidated() {
return rowCacheInvalidated;
}
private void paintPartialRowUpdate(PaintTarget target, Set actionSet)
throws PaintException {
paintPartialRowUpdates(target, actionSet);
paintPartialRowAdditions(target, actionSet);
}
private void paintPartialRowUpdates(PaintTarget target,
Set actionSet) throws PaintException {
final boolean[] iscomponent = findCellsWithComponents();
int firstIx = getFirstUpdatedItemIndex();
int count = getUpdatedRowCount();
target.startTag("urows");
target.addAttribute("firsturowix", firstIx);
target.addAttribute("numurows", count);
// Partial row updates bypass the normal caching mechanism.
Object[][] cells = getVisibleCellsUpdateCacheRows(firstIx, count);
for (int indexInRowbuffer = 0; indexInRowbuffer < count; indexInRowbuffer++) {
final Object itemId = cells[CELL_ITEMID][indexInRowbuffer];
if (shouldHideNullSelectionItem()) {
// Remove null selection item if null selection is not allowed
continue;
}
paintRow(target, cells, isEditable(), actionSet, iscomponent,
indexInRowbuffer, itemId);
}
target.endTag("urows");
maybeThrowCacheUpdateExceptions();
}
private void paintPartialRowAdditions(PaintTarget target,
Set actionSet) throws PaintException {
final boolean[] iscomponent = findCellsWithComponents();
int firstIx = getFirstAddedItemIndex();
int count = getAddedRowCount();
target.startTag("prows");
if (!shouldHideAddedRows()) {
getLogger().log(Level.FINEST,
"Paint rows for add. Index: {0}, count: {1}.",
new Object[] { firstIx, count });
// Partial row additions bypass the normal caching mechanism.
Object[][] cells = getVisibleCellsInsertIntoCache(firstIx, count);
if (cells[0].length < count) {
// delete the rows below, since they will fall beyond the cache
// page.
target.addAttribute("delbelow", true);
count = cells[0].length;
}
for (int indexInRowbuffer = 0; indexInRowbuffer < count; indexInRowbuffer++) {
final Object itemId = cells[CELL_ITEMID][indexInRowbuffer];
if (shouldHideNullSelectionItem()) {
// Remove null selection item if null selection is not
// allowed
continue;
}
paintRow(target, cells, isEditable(), actionSet, iscomponent,
indexInRowbuffer, itemId);
}
} else {
getLogger().log(Level.FINEST,
"Paint rows for remove. Index: {0}, count: {1}.",
new Object[] { firstIx, count });
removeRowsFromCacheAndFillBottom(firstIx, count);
target.addAttribute("hide", true);
}
target.addAttribute("firstprowix", firstIx);
target.addAttribute("numprows", count);
target.endTag("prows");
maybeThrowCacheUpdateExceptions();
}
/**
* Subclass and override this to enable partial row updates and additions,
* which bypass the normal caching mechanism. This is useful for e.g.
* TreeTable.
*
* @return true if this update is a partial row update, false if not. For
* plain Table it is always false.
*/
protected boolean isPartialRowUpdate() {
return false;
}
/**
* Subclass and override this to enable partial row additions, bypassing the
* normal caching mechanism. This is useful for e.g. TreeTable, where
* expanding a node should only fetch and add the items inside of that node.
*
* @return The index of the first added item. For plain Table it is always
* 0.
*/
protected int getFirstAddedItemIndex() {
return 0;
}
/**
* Subclass and override this to enable partial row additions, bypassing the
* normal caching mechanism. This is useful for e.g. TreeTable, where
* expanding a node should only fetch and add the items inside of that node.
*
* @return the number of rows to be added, starting at the index returned by
* {@link #getFirstAddedItemIndex()}. For plain Table it is always
* 0.
*/
protected int getAddedRowCount() {
return 0;
}
/**
* Subclass and override this to enable removing of rows, bypassing the
* normal caching and lazy loading mechanism. This is useful for e.g.
* TreeTable, when you need to hide certain rows as a node is collapsed.
*
* This should return true if the rows pointed to by
* {@link #getFirstAddedItemIndex()} and {@link #getAddedRowCount()} should
* be hidden instead of added.
*
* @return whether the rows to add (see {@link #getFirstAddedItemIndex()}
* and {@link #getAddedRowCount()}) should be added or hidden. For
* plain Table it is always false.
*/
protected boolean shouldHideAddedRows() {
return false;
}
/**
* Subclass and override this to enable partial row updates, bypassing the
* normal caching and lazy loading mechanism. This is useful for updating
* the state of certain rows, e.g. in the TreeTable the collapsed state of a
* single node is updated using this mechanism.
*
* @return the index of the first item to be updated. For plain Table it is
* always 0.
*/
protected int getFirstUpdatedItemIndex() {
return 0;
}
/**
* Subclass and override this to enable partial row updates, bypassing the
* normal caching and lazy loading mechanism. This is useful for updating
* the state of certain rows, e.g. in the TreeTable the collapsed state of a
* single node is updated using this mechanism.
*
* @return the number of rows to update, starting at the index returned by
* {@link #getFirstUpdatedItemIndex()}. For plain table it is always
* 0.
*/
protected int getUpdatedRowCount() {
return 0;
}
private void paintTableAttributes(PaintTarget target, int rows, int total)
throws PaintException {
paintTabIndex(target);
paintDragMode(target);
paintSelectMode(target);
if (cacheRate != CACHE_RATE_DEFAULT) {
target.addAttribute("cr", cacheRate);
}
target.addAttribute("cols", getVisibleColumns().length);
target.addAttribute("rows", rows);
target.addAttribute("firstrow",
(reqFirstRowToPaint >= 0 ? reqFirstRowToPaint
: firstToBeRenderedInClient));
target.addAttribute("totalrows", total);
if (getPageLength() != 0) {
target.addAttribute("pagelength", getPageLength());
}
if (areColumnHeadersEnabled()) {
target.addAttribute("colheaders", true);
}
if (rowHeadersAreEnabled()) {
target.addAttribute("rowheaders", true);
}
target.addAttribute("colfooters", columnFootersVisible);
// The cursors are only shown on pageable table
if (getCurrentPageFirstItemIndex() != 0 || getPageLength() > 0) {
target.addVariable(this, "firstvisible",
getCurrentPageFirstItemIndex());
target.addVariable(this, "firstvisibleonlastpage",
currentPageFirstItemIndexOnLastPage);
}
}
/**
* Resets and paints "to be painted next" variables. Also reset pageBuffer
*/
private void resetVariablesAndPageBuffer(PaintTarget target)
throws PaintException {
reqFirstRowToPaint = -1;
reqRowsToPaint = -1;
containerChangeToBeRendered = false;
target.addVariable(this, "reqrows", reqRowsToPaint);
target.addVariable(this, "reqfirstrow", reqFirstRowToPaint);
}
private boolean areColumnHeadersEnabled() {
return getColumnHeaderMode() != ColumnHeaderMode.HIDDEN;
}
private void paintVisibleColumns(PaintTarget target) throws PaintException {
target.startTag("visiblecolumns");
if (rowHeadersAreEnabled()) {
target.startTag("column");
target.addAttribute("cid", ROW_HEADER_COLUMN_KEY);
paintColumnWidth(target, ROW_HEADER_FAKE_PROPERTY_ID);
paintColumnExpandRatio(target, ROW_HEADER_FAKE_PROPERTY_ID);
target.endTag("column");
}
final Collection sortables = getSortableContainerPropertyIds();
for (Object colId : visibleColumns) {
if (colId != null) {
target.startTag("column");
target.addAttribute("cid", columnIdMap.key(colId));
final String head = getColumnHeader(colId);
target.addAttribute("caption", (head != null ? head : ""));
final String foot = getColumnFooter(colId);
target.addAttribute("fcaption", (foot != null ? foot : ""));
if (isColumnCollapsed(colId)) {
target.addAttribute("collapsed", true);
}
if (areColumnHeadersEnabled()) {
if (getColumnIcon(colId) != null) {
target.addAttribute("icon", getColumnIcon(colId));
}
if (sortables.contains(colId)) {
target.addAttribute("sortable", true);
}
}
if (!Align.LEFT.equals(getColumnAlignment(colId))) {
target.addAttribute("align", getColumnAlignment(colId)
.toString());
}
paintColumnWidth(target, colId);
paintColumnExpandRatio(target, colId);
target.endTag("column");
}
}
target.endTag("visiblecolumns");
}
private void paintAvailableColumns(PaintTarget target)
throws PaintException {
if (columnCollapsingAllowed) {
final HashSet collapsedCols = new HashSet();
for (Object colId : visibleColumns) {
if (isColumnCollapsed(colId)) {
collapsedCols.add(colId);
}
}
final String[] collapsedKeys = new String[collapsedCols.size()];
int nextColumn = 0;
for (Object colId : visibleColumns) {
if (isColumnCollapsed(colId)) {
collapsedKeys[nextColumn++] = columnIdMap.key(colId);
}
}
target.addVariable(this, "collapsedcolumns", collapsedKeys);
final String[] noncollapsibleKeys = new String[noncollapsibleColumns
.size()];
nextColumn = 0;
for (Object colId : noncollapsibleColumns) {
noncollapsibleKeys[nextColumn++] = columnIdMap.key(colId);
}
target.addVariable(this, "noncollapsiblecolumns",
noncollapsibleKeys);
}
}
private void paintActions(PaintTarget target, final Set actionSet)
throws PaintException {
if (!actionSet.isEmpty()) {
target.addVariable(this, "action", "");
target.startTag("actions");
for (Action a : actionSet) {
target.startTag("action");
if (a.getCaption() != null) {
target.addAttribute("caption", a.getCaption());
}
if (a.getIcon() != null) {
target.addAttribute("icon", a.getIcon());
}
target.addAttribute("key", actionMapper.key(a));
target.endTag("action");
}
target.endTag("actions");
}
}
private void paintColumnOrder(PaintTarget target) throws PaintException {
if (columnReorderingAllowed) {
final String[] colorder = new String[visibleColumns.size()];
int i = 0;
for (Object colId : visibleColumns) {
colorder[i++] = columnIdMap.key(colId);
}
target.addVariable(this, "columnorder", colorder);
}
}
private void paintSorting(PaintTarget target) throws PaintException {
// Sorting
if (getContainerDataSource() instanceof Container.Sortable) {
target.addVariable(this, "sortcolumn",
columnIdMap.key(sortContainerPropertyId));
target.addVariable(this, "sortascending", sortAscending);
}
}
private void paintRows(PaintTarget target, final Object[][] cells,
final Set actionSet) throws PaintException {
final boolean[] iscomponent = findCellsWithComponents();
target.startTag("rows");
// cells array contains all that are supposed to be visible on client,
// but we'll start from the one requested by client
int start = 0;
if (reqFirstRowToPaint != -1 && firstToBeRenderedInClient != -1) {
start = reqFirstRowToPaint - firstToBeRenderedInClient;
}
int end = cells[0].length;
if (reqRowsToPaint != -1) {
end = start + reqRowsToPaint;
}
// sanity check
if (lastToBeRenderedInClient != -1 && lastToBeRenderedInClient < end) {
end = lastToBeRenderedInClient + 1;
}
if (start > cells[CELL_ITEMID].length || start < 0) {
start = 0;
}
if (end > cells[CELL_ITEMID].length) {
end = cells[CELL_ITEMID].length;
}
for (int indexInRowbuffer = start; indexInRowbuffer < end; indexInRowbuffer++) {
final Object itemId = cells[CELL_ITEMID][indexInRowbuffer];
if (shouldHideNullSelectionItem()) {
// Remove null selection item if null selection is not allowed
continue;
}
paintRow(target, cells, isEditable(), actionSet, iscomponent,
indexInRowbuffer, itemId);
}
target.endTag("rows");
}
private boolean[] findCellsWithComponents() {
final boolean[] isComponent = new boolean[visibleColumns.size()];
int ix = 0;
for (Object columnId : visibleColumns) {
if (columnGenerators.containsKey(columnId)) {
isComponent[ix++] = true;
} else {
final Class colType = getType(columnId);
isComponent[ix++] = colType != null
&& Component.class.isAssignableFrom(colType);
}
}
return isComponent;
}
private void paintVisibleColumnOrder(PaintTarget target) {
// Visible column order
final ArrayList visibleColOrder = new ArrayList();
for (Object columnId : visibleColumns) {
if (!isColumnCollapsed(columnId)) {
visibleColOrder.add(columnIdMap.key(columnId));
}
}
target.addAttribute("vcolorder", visibleColOrder.toArray());
}
private Set findAndPaintBodyActions(PaintTarget target) {
Set actionSet = new LinkedHashSet();
if (actionHandlers != null) {
final ArrayList keys = new ArrayList();
for (Handler ah : actionHandlers) {
// Getting actions for the null item, which in this case means
// the body item
final Action[] actions = ah.getActions(null, this);
if (actions != null) {
for (Action action : actions) {
actionSet.add(action);
keys.add(actionMapper.key(action));
}
}
}
target.addAttribute("alb", keys.toArray());
}
return actionSet;
}
private boolean shouldHideNullSelectionItem() {
return !isNullSelectionAllowed() && getNullSelectionItemId() != null
&& containsId(getNullSelectionItemId());
}
private int findNumRowsToPaint(PaintTarget target, final Object[][] cells)
throws PaintException {
int rows;
if (reqRowsToPaint >= 0) {
rows = reqRowsToPaint;
} else {
rows = cells[0].length;
if (alwaysRecalculateColumnWidths) {
// TODO experimental feature for now: tell the client to
// recalculate column widths.
// We'll only do this for paints that do not originate from
// table scroll/cache requests (i.e when reqRowsToPaint<0)
target.addAttribute("recalcWidths", true);
}
}
return rows;
}
private void paintSelectMode(PaintTarget target) throws PaintException {
if (multiSelectMode != MultiSelectMode.DEFAULT) {
target.addAttribute("multiselectmode", multiSelectMode.ordinal());
}
if (isSelectable()) {
target.addAttribute("selectmode", (isMultiSelect() ? "multi"
: "single"));
} else {
target.addAttribute("selectmode", "none");
}
if (!isNullSelectionAllowed()) {
target.addAttribute("nsa", false);
}
// selection support
// The select variable is only enabled if selectable
if (isSelectable()) {
target.addVariable(this, "selected", findSelectedKeys());
}
}
private String[] findSelectedKeys() {
LinkedList selectedKeys = new LinkedList();
if (isMultiSelect()) {
HashSet sel = new HashSet((Set) getValue());
Collection vids = getVisibleItemIds();
for (Iterator it = vids.iterator(); it.hasNext();) {
Object id = it.next();
if (sel.contains(id)) {
selectedKeys.add(itemIdMapper.key(id));
}
}
} else {
Object value = getValue();
if (value == null) {
value = getNullSelectionItemId();
}
if (value != null) {
selectedKeys.add(itemIdMapper.key(value));
}
}
return selectedKeys.toArray(new String[selectedKeys.size()]);
}
private void paintDragMode(PaintTarget target) throws PaintException {
if (dragMode != TableDragMode.NONE) {
target.addAttribute("dragmode", dragMode.ordinal());
}
}
private void paintTabIndex(PaintTarget target) throws PaintException {
// The tab ordering number
if (getTabIndex() > 0) {
target.addAttribute("tabindex", getTabIndex());
}
}
private void paintColumnWidth(PaintTarget target, final Object columnId)
throws PaintException {
if (columnWidths.containsKey(columnId)) {
target.addAttribute("width", getColumnWidth(columnId));
}
}
private void paintColumnExpandRatio(PaintTarget target,
final Object columnId) throws PaintException {
if (columnExpandRatios.containsKey(columnId)) {
target.addAttribute("er", getColumnExpandRatio(columnId));
}
}
private boolean rowHeadersAreEnabled() {
return getRowHeaderMode() != ROW_HEADER_MODE_HIDDEN;
}
private void paintRow(PaintTarget target, final Object[][] cells,
final boolean iseditable, final Set actionSet,
final boolean[] iscomponent, int indexInRowbuffer,
final Object itemId) throws PaintException {
target.startTag("tr");
paintRowAttributes(target, cells, actionSet, indexInRowbuffer, itemId);
// cells
int currentColumn = 0;
for (final Iterator it = visibleColumns.iterator(); it
.hasNext(); currentColumn++) {
final Object columnId = it.next();
if (columnId == null || isColumnCollapsed(columnId)) {
continue;
}
/*
* For each cell, if a cellStyleGenerator is specified, get the
* specific style for the cell. If there is any, add it to the
* target.
*/
if (cellStyleGenerator != null) {
String cellStyle = cellStyleGenerator.getStyle(this, itemId,
columnId);
if (cellStyle != null && !cellStyle.equals("")) {
target.addAttribute("style-" + columnIdMap.key(columnId),
cellStyle);
}
}
if ((iscomponent[currentColumn] || iseditable || cells[CELL_GENERATED_ROW][indexInRowbuffer] != null)
&& Component.class.isInstance(cells[CELL_FIRSTCOL
+ currentColumn][indexInRowbuffer])) {
final Component c = (Component) cells[CELL_FIRSTCOL
+ currentColumn][indexInRowbuffer];
if (c == null
|| !LegacyCommunicationManager
.isComponentVisibleToClient(c)) {
target.addText("");
} else {
LegacyPaint.paint(c, target);
}
} else {
target.addText((String) cells[CELL_FIRSTCOL + currentColumn][indexInRowbuffer]);
}
paintCellTooltips(target, itemId, columnId);
}
target.endTag("tr");
}
private void paintCellTooltips(PaintTarget target, Object itemId,
Object columnId) throws PaintException {
if (itemDescriptionGenerator != null) {
String itemDescription = itemDescriptionGenerator
.generateDescription(this, itemId, columnId);
if (itemDescription != null && !itemDescription.equals("")) {
target.addAttribute("descr-" + columnIdMap.key(columnId),
itemDescription);
}
}
}
private void paintRowTooltips(PaintTarget target, Object itemId)
throws PaintException {
if (itemDescriptionGenerator != null) {
String rowDescription = itemDescriptionGenerator
.generateDescription(this, itemId, null);
if (rowDescription != null && !rowDescription.equals("")) {
target.addAttribute("rowdescr", rowDescription);
}
}
}
private void paintRowAttributes(PaintTarget target, final Object[][] cells,
final Set actionSet, int indexInRowbuffer,
final Object itemId) throws PaintException {
// tr attributes
paintRowIcon(target, cells, indexInRowbuffer);
paintRowHeader(target, cells, indexInRowbuffer);
paintGeneratedRowInfo(target, cells, indexInRowbuffer);
target.addAttribute("key",
Integer.parseInt(cells[CELL_KEY][indexInRowbuffer].toString()));
if (isSelected(itemId)) {
target.addAttribute("selected", true);
}
// Actions
if (actionHandlers != null) {
final ArrayList keys = new ArrayList();
for (Handler ah : actionHandlers) {
final Action[] aa = ah.getActions(itemId, this);
if (aa != null) {
for (int ai = 0; ai < aa.length; ai++) {
final String key = actionMapper.key(aa[ai]);
actionSet.add(aa[ai]);
keys.add(key);
}
}
}
target.addAttribute("al", keys.toArray());
}
/*
* For each row, if a cellStyleGenerator is specified, get the specific
* style for the cell, using null as propertyId. If there is any, add it
* to the target.
*/
if (cellStyleGenerator != null) {
String rowStyle = cellStyleGenerator.getStyle(this, itemId, null);
if (rowStyle != null && !rowStyle.equals("")) {
target.addAttribute("rowstyle", rowStyle);
}
}
paintRowTooltips(target, itemId);
paintRowAttributes(target, itemId);
}
private void paintGeneratedRowInfo(PaintTarget target, Object[][] cells,
int indexInRowBuffer) throws PaintException {
GeneratedRow generatedRow = (GeneratedRow) cells[CELL_GENERATED_ROW][indexInRowBuffer];
if (generatedRow != null) {
target.addAttribute("gen_html", generatedRow.isHtmlContentAllowed());
target.addAttribute("gen_span", generatedRow.isSpanColumns());
target.addAttribute("gen_widget",
generatedRow.getValue() instanceof Component);
}
}
protected void paintRowHeader(PaintTarget target, Object[][] cells,
int indexInRowbuffer) throws PaintException {
if (rowHeadersAreEnabled()) {
if (cells[CELL_HEADER][indexInRowbuffer] != null) {
target.addAttribute("caption",
(String) cells[CELL_HEADER][indexInRowbuffer]);
}
}
}
protected void paintRowIcon(PaintTarget target, final Object[][] cells,
int indexInRowbuffer) throws PaintException {
if (rowHeadersAreEnabled()
&& cells[CELL_ICON][indexInRowbuffer] != null) {
target.addAttribute("icon",
(Resource) cells[CELL_ICON][indexInRowbuffer]);
}
}
/**
* A method where extended Table implementations may add their custom
* attributes for rows.
*
* @param target
* @param itemId
*/
protected void paintRowAttributes(PaintTarget target, Object itemId)
throws PaintException {
}
/**
* Gets the cached visible table contents.
*
* @return the cached visible table contents.
*/
private Object[][] getVisibleCells() {
if (pageBuffer == null) {
refreshRenderedCells();
}
return pageBuffer;
}
/**
* Gets the 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.
*
* @param rowId
* the Id of the row (same as item Id).
* @param colId
* the Id of the column.
* @param property
* the Property to be presented.
* @return Object Either formatted value or Component for field.
* @see #setTableFieldFactory(TableFieldFactory)
*/
protected Object getPropertyValue(Object rowId, Object colId,
Property property) {
if (isEditable() && fieldFactory != null) {
final Field f = fieldFactory.createField(
getContainerDataSource(), rowId, colId, this);
if (f != null) {
// Remember that we have made this association so we can remove
// it when the component is removed
associatedProperties.put(f, property);
bindPropertyToField(rowId, colId, property, f);
return f;
}
}
return formatPropertyValue(rowId, colId, property);
}
/**
* Binds an item property to a field generated by TableFieldFactory. The
* default behavior is to bind property straight to Field. If
* Property.Viewer type property (e.g. PropertyFormatter) is already set for
* field, the property is bound to that Property.Viewer.
*
* @param rowId
* @param colId
* @param property
* @param field
* @since 6.7.3
*/
protected void bindPropertyToField(Object rowId, Object colId,
Property property, Field field) {
// check if field has a property that is Viewer set. In that case we
// expect developer has e.g. PropertyFormatter that he wishes to use and
// assign the property to the Viewer instead.
boolean hasFilterProperty = field.getPropertyDataSource() != null
&& (field.getPropertyDataSource() instanceof Property.Viewer);
if (hasFilterProperty) {
((Property.Viewer) field.getPropertyDataSource())
.setPropertyDataSource(property);
} else {
field.setPropertyDataSource(property);
}
}
/**
* Formats table cell property values. By default the property.toString()
* and return a empty string for null properties.
*
* @param rowId
* the Id of the row (same as item Id).
* @param colId
* the Id of the column.
* @param property
* the Property to be formatted.
* @return the String representation of property and its value.
* @since 3.1
*/
protected String formatPropertyValue(Object rowId, Object colId,
Property property) {
if (property == null) {
return "";
}
Converter converter = null;
if (hasConverter(colId)) {
converter = getConverter(colId);
} else {
converter = (Converter) ConverterUtil.getConverter(String.class,
property.getType(), getSession());
}
Object value = property.getValue();
if (converter != null) {
return converter.convertToPresentation(value, String.class,
getLocale());
}
return (null != value) ? value.toString() : "";
}
/* Action container */
/**
* Registers a new action handler for this container
*
* @see com.vaadin.event.Action.Container#addActionHandler(Action.Handler)
*/
@Override
public void addActionHandler(Action.Handler actionHandler) {
if (actionHandler != null) {
if (actionHandlers == null) {
actionHandlers = new LinkedList();
actionMapper = new KeyMapper();
}
if (!actionHandlers.contains(actionHandler)) {
actionHandlers.add(actionHandler);
// Assures the visual refresh. No need to reset the page buffer
// before as the content has not changed, only the action
// handlers.
refreshRenderedCells();
}
}
}
/**
* Removes a previously registered action handler for the contents of this
* container.
*
* @see com.vaadin.event.Action.Container#removeActionHandler(Action.Handler)
*/
@Override
public void removeActionHandler(Action.Handler actionHandler) {
if (actionHandlers != null && actionHandlers.contains(actionHandler)) {
actionHandlers.remove(actionHandler);
if (actionHandlers.isEmpty()) {
actionHandlers = null;
actionMapper = null;
}
// Assures the visual refresh. No need to reset the page buffer
// before as the content has not changed, only the action
// handlers.
refreshRenderedCells();
}
}
/**
* Removes all action handlers
*/
public void removeAllActionHandlers() {
actionHandlers = null;
actionMapper = null;
// Assures the visual refresh. No need to reset the page buffer
// before as the content has not changed, only the action
// handlers.
refreshRenderedCells();
}
/* Property value change listening support */
/**
* Notifies this listener that the Property's value has changed.
*
* Also listens changes in rendered items to refresh content area.
*
* @see com.vaadin.data.Property.ValueChangeListener#valueChange(Property.ValueChangeEvent)
*/
@Override
public void valueChange(Property.ValueChangeEvent event) {
if (event.getProperty() == this
|| event.getProperty() == getPropertyDataSource()) {
super.valueChange(event);
} else {
refreshRowCache();
containerChangeToBeRendered = true;
}
markAsDirty();
}
/**
* Clears the current page buffer. Call this before
* {@link #refreshRenderedCells()} to ensure that all content is updated
* from the properties.
*/
protected void resetPageBuffer() {
firstToBeRenderedInClient = -1;
lastToBeRenderedInClient = -1;
reqFirstRowToPaint = -1;
reqRowsToPaint = -1;
pageBuffer = null;
}
/**
* Notifies the component that it is connected to an application.
*
* @see com.vaadin.ui.Component#attach()
*/
@Override
public void attach() {
super.attach();
refreshRenderedCells();
}
/**
* Notifies the component that it is detached from the application
*
* @see com.vaadin.ui.Component#detach()
*/
@Override
public void detach() {
super.detach();
}
/**
* Removes all Items from the Container.
*
* @see com.vaadin.data.Container#removeAllItems()
*/
@Override
public boolean removeAllItems() {
currentPageFirstItemId = null;
currentPageFirstItemIndex = 0;
return super.removeAllItems();
}
/**
* Removes the Item identified by ItemId from the Container.
*
* @see com.vaadin.data.Container#removeItem(Object)
*/
@Override
public boolean removeItem(Object itemId) {
final Object nextItemId = nextItemId(itemId);
final boolean ret = super.removeItem(itemId);
if (ret && (itemId != null) && (itemId.equals(currentPageFirstItemId))) {
currentPageFirstItemId = nextItemId;
}
if (!(items instanceof Container.ItemSetChangeNotifier)) {
refreshRowCache();
}
return ret;
}
/**
* Removes a Property specified by the given Property ID from the Container.
*
* @see com.vaadin.data.Container#removeContainerProperty(Object)
*/
@Override
public boolean removeContainerProperty(Object propertyId)
throws UnsupportedOperationException {
// If a visible property is removed, remove the corresponding column
visibleColumns.remove(propertyId);
columnAlignments.remove(propertyId);
columnIcons.remove(propertyId);
columnHeaders.remove(propertyId);
columnFooters.remove(propertyId);
return super.removeContainerProperty(propertyId);
}
/**
* Adds a new property to the table and show it as a visible column.
*
* @param propertyId
* the Id of the proprty.
* @param type
* the class of the property.
* @param defaultValue
* the default value given for all existing items.
* @see com.vaadin.data.Container#addContainerProperty(Object, Class,
* Object)
*/
@Override
public boolean addContainerProperty(Object propertyId, Class type,
Object defaultValue) throws UnsupportedOperationException {
boolean visibleColAdded = false;
if (!visibleColumns.contains(propertyId)) {
visibleColumns.add(propertyId);
visibleColAdded = true;
}
if (!super.addContainerProperty(propertyId, type, defaultValue)) {
if (visibleColAdded) {
visibleColumns.remove(propertyId);
}
return false;
}
if (!(items instanceof Container.PropertySetChangeNotifier)) {
refreshRowCache();
}
return true;
}
/**
* Adds a new property to the table and show it as a visible column.
*
* @param propertyId
* the Id of the proprty
* @param type
* the class of the property
* @param defaultValue
* the default value given for all existing items
* @param columnHeader
* the Explicit header of the column. If explicit header is not
* needed, this should be set null.
* @param columnIcon
* the Icon of the column. If icon is not needed, this should be
* set null.
* @param columnAlignment
* the Alignment of the column. Null implies align left.
* @throws UnsupportedOperationException
* if the operation is not supported.
* @see com.vaadin.data.Container#addContainerProperty(Object, Class,
* Object)
*/
public boolean addContainerProperty(Object propertyId, Class type,
Object defaultValue, String columnHeader, Resource columnIcon,
Align columnAlignment) throws UnsupportedOperationException {
if (!this.addContainerProperty(propertyId, type, defaultValue)) {
return false;
}
setColumnAlignment(propertyId, columnAlignment);
setColumnHeader(propertyId, columnHeader);
setColumnIcon(propertyId, columnIcon);
return true;
}
/**
* Adds a generated column to the Table.
*
* A generated column is a column that exists only in the Table, not as a
* property in the underlying Container. It shows up just as a regular
* column.
*
*
* A generated column will override a property with the same id, so that the
* generated column is shown instead of the column representing the
* property. Note that getContainerProperty() will still get the real
* property.
*
*
* Table will not listen to value change events from properties overridden
* by generated columns. If the content of your generated column depends on
* properties that are not directly visible in the table, attach value
* change listener to update the content on all depended properties.
* Otherwise your UI might not get updated as expected.
*
*
* Also note that getVisibleColumns() will return the generated columns,
* while getContainerPropertyIds() will not.
*
*
* @param id
* the id of the column to be added
* @param generatedColumn
* the {@link ColumnGenerator} to use for this column
*/
public void addGeneratedColumn(Object id, ColumnGenerator generatedColumn) {
if (generatedColumn == null) {
throw new IllegalArgumentException(
"Can not add null as a GeneratedColumn");
}
if (columnGenerators.containsKey(id)) {
throw new IllegalArgumentException(
"Can not add the same GeneratedColumn twice, id:" + id);
} else {
columnGenerators.put(id, generatedColumn);
/*
* add to visible column list unless already there (overriding
* column from DS)
*/
if (!visibleColumns.contains(id)) {
visibleColumns.add(id);
}
refreshRowCache();
}
}
/**
* Returns the ColumnGenerator used to generate the given column.
*
* @param columnId
* The id of the generated column
* @return The ColumnGenerator used for the given columnId or null.
*/
public ColumnGenerator getColumnGenerator(Object columnId)
throws IllegalArgumentException {
return columnGenerators.get(columnId);
}
/**
* Removes a generated column previously added with addGeneratedColumn.
*
* @param columnId
* id of the generated column to remove
* @return true if the column could be removed (existed in the Table)
*/
public boolean removeGeneratedColumn(Object columnId) {
if (columnGenerators.containsKey(columnId)) {
columnGenerators.remove(columnId);
// remove column from visibleColumns list unless it exists in
// container (generator previously overrode this column)
if (!items.getContainerPropertyIds().contains(columnId)) {
visibleColumns.remove(columnId);
}
refreshRowCache();
return true;
} else {
return false;
}
}
/**
* Returns item identifiers of the items which are currently rendered on the
* client.
*
* Note, that some due to historical reasons the name of the method is bit
* misleading. Some items may be partly or totally out of the viewport of
* the table's scrollable area. Actually detecting rows which can be
* actually seen by the end user may be problematic due to the client server
* architecture. Using {@link #getCurrentPageFirstItemId()} combined with
* {@link #getPageLength()} may produce good enough estimates in some
* situations.
*
* @see com.vaadin.ui.Select#getVisibleItemIds()
*/
@Override
public Collection getVisibleItemIds() {
final LinkedList visible = new LinkedList();
final Object[][] cells = getVisibleCells();
// may be null if the table has not been rendered yet (e.g. not attached
// to a layout)
if (null != cells) {
for (int i = 0; i < cells[CELL_ITEMID].length; i++) {
visible.add(cells[CELL_ITEMID][i]);
}
}
return visible;
}
/**
* Container datasource item set change. Table must flush its buffers on
* change.
*
* @see com.vaadin.data.Container.ItemSetChangeListener#containerItemSetChange(com.vaadin.data.Container.ItemSetChangeEvent)
*/
@Override
public void containerItemSetChange(Container.ItemSetChangeEvent event) {
if (isBeingPainted) {
return;
}
super.containerItemSetChange(event);
// super method clears the key map, must inform client about this to
// avoid getting invalid keys back (#8584)
keyMapperReset = true;
// ensure that page still has first item in page, ignore buffer refresh
// (forced in this method)
setCurrentPageFirstItemIndex(getCurrentPageFirstItemIndex(), false);
refreshRowCache();
}
/**
* Container datasource property set change. Table must flush its buffers on
* change.
*
* @see com.vaadin.data.Container.PropertySetChangeListener#containerPropertySetChange(com.vaadin.data.Container.PropertySetChangeEvent)
*/
@Override
public void containerPropertySetChange(
Container.PropertySetChangeEvent event) {
if (isBeingPainted) {
return;
}
disableContentRefreshing();
super.containerPropertySetChange(event);
// sanitetize visibleColumns. note that we are not adding previously
// non-existing properties as columns
Collection containerPropertyIds = getContainerDataSource()
.getContainerPropertyIds();
LinkedList newVisibleColumns = new LinkedList(
visibleColumns);
for (Iterator iterator = newVisibleColumns.iterator(); iterator
.hasNext();) {
Object id = iterator.next();
if (!(containerPropertyIds.contains(id) || columnGenerators
.containsKey(id))) {
iterator.remove();
}
}
setVisibleColumns(newVisibleColumns.toArray());
// same for collapsed columns
for (Iterator iterator = collapsedColumns.iterator(); iterator
.hasNext();) {
Object id = iterator.next();
if (!(containerPropertyIds.contains(id) || columnGenerators
.containsKey(id))) {
iterator.remove();
}
}
resetPageBuffer();
enableContentRefreshing(true);
}
/**
* Adding new items is not supported.
*
* @throws UnsupportedOperationException
* if set to true.
* @see com.vaadin.ui.Select#setNewItemsAllowed(boolean)
*/
@Override
public void setNewItemsAllowed(boolean allowNewOptions)
throws UnsupportedOperationException {
if (allowNewOptions) {
throw new UnsupportedOperationException();
}
}
/**
* Gets the ID of the Item following the Item that corresponds to itemId.
*
* @see com.vaadin.data.Container.Ordered#nextItemId(java.lang.Object)
*/
@Override
public Object nextItemId(Object itemId) {
return ((Container.Ordered) items).nextItemId(itemId);
}
/**
* Gets the ID of the Item preceding the Item that corresponds to the
* itemId.
*
* @see com.vaadin.data.Container.Ordered#prevItemId(java.lang.Object)
*/
@Override
public Object prevItemId(Object itemId) {
return ((Container.Ordered) items).prevItemId(itemId);
}
/**
* Gets the ID of the first Item in the Container.
*
* @see com.vaadin.data.Container.Ordered#firstItemId()
*/
@Override
public Object firstItemId() {
return ((Container.Ordered) items).firstItemId();
}
/**
* Gets the ID of the last Item in the Container.
*
* @see com.vaadin.data.Container.Ordered#lastItemId()
*/
@Override
public Object lastItemId() {
return ((Container.Ordered) items).lastItemId();
}
/**
* Tests if the Item corresponding to the given Item ID is the first Item in
* the Container.
*
* @see com.vaadin.data.Container.Ordered#isFirstId(java.lang.Object)
*/
@Override
public boolean isFirstId(Object itemId) {
return ((Container.Ordered) items).isFirstId(itemId);
}
/**
* Tests if the Item corresponding to the given Item ID is the last Item in
* the Container.
*
* @see com.vaadin.data.Container.Ordered#isLastId(java.lang.Object)
*/
@Override
public boolean isLastId(Object itemId) {
return ((Container.Ordered) items).isLastId(itemId);
}
/**
* Adds new item after the given item.
*
* @see com.vaadin.data.Container.Ordered#addItemAfter(java.lang.Object)
*/
@Override
public Object addItemAfter(Object previousItemId)
throws UnsupportedOperationException {
Object itemId = ((Container.Ordered) items)
.addItemAfter(previousItemId);
if (!(items instanceof Container.ItemSetChangeNotifier)) {
refreshRowCache();
}
return itemId;
}
/**
* Adds new item after the given item.
*
* @see com.vaadin.data.Container.Ordered#addItemAfter(java.lang.Object,
* java.lang.Object)
*/
@Override
public Item addItemAfter(Object previousItemId, Object newItemId)
throws UnsupportedOperationException {
Item item = ((Container.Ordered) items).addItemAfter(previousItemId,
newItemId);
if (!(items instanceof Container.ItemSetChangeNotifier)) {
refreshRowCache();
}
return item;
}
/**
* Sets the TableFieldFactory that is used to create editor for table cells.
*
* The TableFieldFactory is only used if the Table is editable. By default
* the DefaultFieldFactory is used.
*
* @param fieldFactory
* the field factory to set.
* @see #isEditable
* @see DefaultFieldFactory
*/
public void setTableFieldFactory(TableFieldFactory fieldFactory) {
this.fieldFactory = fieldFactory;
// Assure visual refresh
refreshRowCache();
}
/**
* Gets the TableFieldFactory that is used to create editor for table cells.
*
* The FieldFactory is only used if the Table is editable.
*
* @return TableFieldFactory used to create the Field instances.
* @see #isEditable
*/
public TableFieldFactory getTableFieldFactory() {
return fieldFactory;
}
/**
* 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.
*
* @return true if table is editable, false oterwise.
* @see Field
* @see FieldFactory
*
*/
public boolean isEditable() {
return editable;
}
/**
* Sets 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.
*
* @param editable
* true if table should be editable by user.
* @see Field
* @see FieldFactory
*
*/
public void setEditable(boolean editable) {
this.editable = editable;
// Assure visual refresh
refreshRowCache();
}
/**
* Sorts the table.
*
* @throws UnsupportedOperationException
* if the container data source does not implement
* Container.Sortable
* @see com.vaadin.data.Container.Sortable#sort(java.lang.Object[],
* boolean[])
*
*/
@Override
public void sort(Object[] propertyId, boolean[] ascending)
throws UnsupportedOperationException {
final Container c = getContainerDataSource();
if (c instanceof Container.Sortable) {
final int pageIndex = getCurrentPageFirstItemIndex();
boolean refreshingPreviouslyEnabled = disableContentRefreshing();
((Container.Sortable) c).sort(propertyId, ascending);
setCurrentPageFirstItemIndex(pageIndex);
if (refreshingPreviouslyEnabled) {
enableContentRefreshing(true);
}
} else if (c != null) {
throw new UnsupportedOperationException(
"Underlying Data does not allow sorting");
}
}
/**
* Sorts the table by currently selected sorting column.
*
* @throws UnsupportedOperationException
* if the container data source does not implement
* Container.Sortable
*/
public void sort() {
if (getSortContainerPropertyId() == null) {
return;
}
sort(new Object[] { sortContainerPropertyId },
new boolean[] { sortAscending });
}
/**
* Gets the container property IDs, which can be used to sort the item.
*
* Note that the {@link #isSortEnabled()} state affects what this method
* returns. Disabling sorting causes this method to always return an empty
* collection.
*
*
* @see com.vaadin.data.Container.Sortable#getSortableContainerPropertyIds()
*/
@Override
public Collection getSortableContainerPropertyIds() {
final Container c = getContainerDataSource();
if (c instanceof Container.Sortable && isSortEnabled()) {
return ((Container.Sortable) c).getSortableContainerPropertyIds();
} else {
return Collections.EMPTY_LIST;
}
}
/**
* Gets the currently sorted column property ID.
*
* @return the Container property id of the currently sorted column.
*/
public Object getSortContainerPropertyId() {
return sortContainerPropertyId;
}
/**
* Sets the currently sorted column property id.
*
* @param propertyId
* the Container property id of the currently sorted column.
*/
public void setSortContainerPropertyId(Object propertyId) {
setSortContainerPropertyId(propertyId, true);
}
/**
* Internal method to set currently sorted column property id. With doSort
* flag actual sorting may be bypassed.
*
* @param propertyId
* @param doSort
*/
private void setSortContainerPropertyId(Object propertyId, boolean doSort) {
if ((sortContainerPropertyId != null && !sortContainerPropertyId
.equals(propertyId))
|| (sortContainerPropertyId == null && propertyId != null)) {
sortContainerPropertyId = propertyId;
if (doSort) {
sort();
// Assures the visual refresh. This should not be necessary as
// sort() calls refreshRowCache
refreshRenderedCells();
}
}
}
/**
* Is the table currently sorted in ascending order.
*
* @return true if ascending, false if descending.
*/
public boolean isSortAscending() {
return sortAscending;
}
/**
* Sets the table in ascending order.
*
* @param ascending
* true if ascending, false if
* descending.
*/
public void setSortAscending(boolean ascending) {
setSortAscending(ascending, true);
}
/**
* Internal method to set sort ascending. With doSort flag actual sort can
* be bypassed.
*
* @param ascending
* @param doSort
*/
private void setSortAscending(boolean ascending, boolean doSort) {
if (sortAscending != ascending) {
sortAscending = ascending;
if (doSort) {
sort();
// Assures the visual refresh. This should not be necessary as
// sort() calls refreshRowCache
refreshRenderedCells();
}
}
}
/**
* Is sorting disabled altogether.
*
* True iff no sortable columns are given even in the case where data source
* would support this.
*
* @return True iff sorting is disabled.
* @deprecated As of 7.0, use {@link #isSortEnabled()} instead
*/
@Deprecated
public boolean isSortDisabled() {
return !isSortEnabled();
}
/**
* Checks if sorting is enabled.
*
* @return true if sorting by the user is allowed, false otherwise
*/
public boolean isSortEnabled() {
return sortEnabled;
}
/**
* Disables the sorting by the user altogether.
*
* @param sortDisabled
* True iff sorting is disabled.
* @deprecated As of 7.0, use {@link #setSortEnabled(boolean)} instead
*/
@Deprecated
public void setSortDisabled(boolean sortDisabled) {
setSortEnabled(!sortDisabled);
}
/**
* Enables or disables sorting.
*
* Setting this to false disallows sorting by the user. It is still possible
* to call {@link #sort()}.
*
*
* @param sortEnabled
* true to allow the user to sort the table, false to disallow it
*/
public void setSortEnabled(boolean sortEnabled) {
if (this.sortEnabled != sortEnabled) {
this.sortEnabled = sortEnabled;
markAsDirty();
}
}
/**
* Used to create "generated columns"; columns that exist only in the Table,
* not in the underlying Container. Implement this interface and pass it to
* Table.addGeneratedColumn along with an id for the column to be generated.
*
*/
public interface ColumnGenerator extends Serializable {
/**
* Called by Table when a cell in a generated column needs to be
* generated.
*
* @param source
* the source Table
* @param itemId
* the itemId (aka rowId) for the of the cell to be generated
* @param columnId
* the id for the generated column (as specified in
* addGeneratedColumn)
* @return A {@link Component} that should be rendered in the cell or a
* {@link String} that should be displayed in the cell. Other
* return values are not supported.
*/
public abstract Object generateCell(Table source, Object itemId,
Object columnId);
}
/**
* Set cell style generator for Table.
*
* @param cellStyleGenerator
* New cell style generator or null to remove generator.
*/
public void setCellStyleGenerator(CellStyleGenerator cellStyleGenerator) {
this.cellStyleGenerator = cellStyleGenerator;
// Assures the visual refresh. No need to reset the page buffer
// before as the content has not changed, only the style generators
refreshRenderedCells();
}
/**
* Get the current cell style generator.
*
*/
public CellStyleGenerator getCellStyleGenerator() {
return cellStyleGenerator;
}
/**
* Allow to define specific style on cells (and rows) contents. Implements
* this interface and pass it to Table.setCellStyleGenerator. Row styles are
* generated when porpertyId is null. The CSS class name that will be added
* to the cell content is v-table-cell-content-[style name] , and
* the row style will be v-table-row-[style name] .
*/
public interface CellStyleGenerator extends Serializable {
/**
* Called by Table when a cell (and row) is painted.
*
* @param source
* the source Table
* @param itemId
* The itemId of the painted cell
* @param propertyId
* The propertyId of the cell, null when getting row style
* @return The style name to add to this cell or row. (the CSS class
* name will be v-table-cell-content-[style name], or
* v-table-row-[style name] for rows)
*/
public abstract String getStyle(Table source, Object itemId,
Object propertyId);
}
@Override
public void addItemClickListener(ItemClickListener listener) {
addListener(TableConstants.ITEM_CLICK_EVENT_ID, ItemClickEvent.class,
listener, ItemClickEvent.ITEM_CLICK_METHOD);
}
/**
* @deprecated As of 7.0, replaced by
* {@link #addItemClickListener(ItemClickListener)}
**/
@Override
@Deprecated
public void addListener(ItemClickListener listener) {
addItemClickListener(listener);
}
@Override
public void removeItemClickListener(ItemClickListener listener) {
removeListener(TableConstants.ITEM_CLICK_EVENT_ID,
ItemClickEvent.class, listener);
}
/**
* @deprecated As of 7.0, replaced by
* {@link #removeItemClickListener(ItemClickListener)}
**/
@Override
@Deprecated
public void removeListener(ItemClickListener listener) {
removeItemClickListener(listener);
}
// Identical to AbstractCompoenentContainer.setEnabled();
@Override
public void setEnabled(boolean enabled) {
super.setEnabled(enabled);
if (getParent() != null && !getParent().isEnabled()) {
// some ancestor still disabled, don't update children
return;
} else {
markAsDirtyRecursive();
}
}
/**
* Sets the drag start mode of the Table. Drag start mode controls how Table
* behaves as a drag source.
*
* @param newDragMode
*/
public void setDragMode(TableDragMode newDragMode) {
dragMode = newDragMode;
markAsDirty();
}
/**
* @return the current start mode of the Table. Drag start mode controls how
* Table behaves as a drag source.
*/
public TableDragMode getDragMode() {
return dragMode;
}
/**
* Concrete implementation of {@link DataBoundTransferable} for data
* transferred from a table.
*
* @see {@link DataBoundTransferable}.
*
* @since 6.3
*/
public class TableTransferable extends DataBoundTransferable {
protected TableTransferable(Map rawVariables) {
super(Table.this, rawVariables);
Object object = rawVariables.get("itemId");
if (object != null) {
setData("itemId", itemIdMapper.get((String) object));
}
object = rawVariables.get("propertyId");
if (object != null) {
setData("propertyId", columnIdMap.get((String) object));
}
}
@Override
public Object getItemId() {
return getData("itemId");
}
@Override
public Object getPropertyId() {
return getData("propertyId");
}
@Override
public Table getSourceComponent() {
return (Table) super.getSourceComponent();
}
}
@Override
public TableTransferable getTransferable(Map rawVariables) {
TableTransferable transferable = new TableTransferable(rawVariables);
return transferable;
}
@Override
public DropHandler getDropHandler() {
return dropHandler;
}
public void setDropHandler(DropHandler dropHandler) {
this.dropHandler = dropHandler;
}
@Override
public AbstractSelectTargetDetails translateDropTargetDetails(
Map clientVariables) {
return new AbstractSelectTargetDetails(clientVariables);
}
/**
* Sets the behavior of how the multi-select mode should behave when the
* table is both selectable and in multi-select mode.
*
* Note, that on some clients the mode may not be respected. E.g. on touch
* based devices CTRL/SHIFT base selection method is invalid, so touch based
* browsers always use the {@link MultiSelectMode#SIMPLE}.
*
* @param mode
* The select mode of the table
*/
public void setMultiSelectMode(MultiSelectMode mode) {
multiSelectMode = mode;
markAsDirty();
}
/**
* Returns the select mode in which multi-select is used.
*
* @return The multi select mode
*/
public MultiSelectMode getMultiSelectMode() {
return multiSelectMode;
}
/**
* Lazy loading accept criterion for Table. Accepted target rows are loaded
* from server once per drag and drop operation. Developer must override one
* method that decides on which rows the currently dragged data can be
* dropped.
*
*
* Initially pretty much no data is sent to client. On first required
* criterion check (per drag request) the client side data structure is
* initialized from server and no subsequent requests requests are needed
* during that drag and drop operation.
*/
public static abstract class TableDropCriterion extends ServerSideCriterion {
private Table table;
private Set allowedItemIds;
/*
* (non-Javadoc)
*
* @see
* com.vaadin.event.dd.acceptcriteria.ServerSideCriterion#getIdentifier
* ()
*/
@Override
protected String getIdentifier() {
return TableDropCriterion.class.getCanonicalName();
}
/*
* (non-Javadoc)
*
* @see
* com.vaadin.event.dd.acceptcriteria.AcceptCriterion#accepts(com.vaadin
* .event.dd.DragAndDropEvent)
*/
@Override
@SuppressWarnings("unchecked")
public boolean accept(DragAndDropEvent dragEvent) {
AbstractSelectTargetDetails dropTargetData = (AbstractSelectTargetDetails) dragEvent
.getTargetDetails();
table = (Table) dragEvent.getTargetDetails().getTarget();
Collection visibleItemIds = table.getVisibleItemIds();
allowedItemIds = getAllowedItemIds(dragEvent, table,
(Collection) visibleItemIds);
return allowedItemIds.contains(dropTargetData.getItemIdOver());
}
/*
* (non-Javadoc)
*
* @see
* com.vaadin.event.dd.acceptcriteria.AcceptCriterion#paintResponse(
* com.vaadin.server.PaintTarget)
*/
@Override
public void paintResponse(PaintTarget target) throws PaintException {
/*
* send allowed nodes to client so subsequent requests can be
* avoided
*/
Object[] array = allowedItemIds.toArray();
for (int i = 0; i < array.length; i++) {
String key = table.itemIdMapper.key(array[i]);
array[i] = key;
}
target.addAttribute("allowedIds", array);
}
/**
* @param dragEvent
* @param table
* the table for which the allowed item identifiers are
* defined
* @param visibleItemIds
* the list of currently rendered item identifiers, accepted
* item id's need to be detected only for these visible items
* @return the set of identifiers for items on which the dragEvent will
* be accepted
*/
protected abstract Set getAllowedItemIds(
DragAndDropEvent dragEvent, Table table,
Collection visibleItemIds);
}
/**
* Click event fired when clicking on the Table headers. The event includes
* a reference the the Table the event originated from, the property id of
* the column which header was pressed and details about the mouse event
* itself.
*/
public static class HeaderClickEvent extends ClickEvent {
public static final Method HEADER_CLICK_METHOD;
static {
try {
// Set the header click method
HEADER_CLICK_METHOD = HeaderClickListener.class
.getDeclaredMethod("headerClick",
new Class[] { HeaderClickEvent.class });
} catch (final java.lang.NoSuchMethodException e) {
// This should never happen
throw new java.lang.RuntimeException(e);
}
}
// The property id of the column which header was pressed
private final Object columnPropertyId;
public HeaderClickEvent(Component source, Object propertyId,
MouseEventDetails details) {
super(source, details);
columnPropertyId = propertyId;
}
/**
* Gets the property id of the column which header was pressed
*
* @return The column propety id
*/
public Object getPropertyId() {
return columnPropertyId;
}
}
/**
* Click event fired when clicking on the Table footers. The event includes
* a reference the the Table the event originated from, the property id of
* the column which header was pressed and details about the mouse event
* itself.
*/
public static class FooterClickEvent extends ClickEvent {
public static final Method FOOTER_CLICK_METHOD;
static {
try {
// Set the header click method
FOOTER_CLICK_METHOD = FooterClickListener.class
.getDeclaredMethod("footerClick",
new Class[] { FooterClickEvent.class });
} catch (final java.lang.NoSuchMethodException e) {
// This should never happen
throw new java.lang.RuntimeException(e);
}
}
// The property id of the column which header was pressed
private final Object columnPropertyId;
/**
* Constructor
*
* @param source
* The source of the component
* @param propertyId
* The propertyId of the column
* @param details
* The mouse details of the click
*/
public FooterClickEvent(Component source, Object propertyId,
MouseEventDetails details) {
super(source, details);
columnPropertyId = propertyId;
}
/**
* Gets the property id of the column which header was pressed
*
* @return The column propety id
*/
public Object getPropertyId() {
return columnPropertyId;
}
}
/**
* Interface for the listener for column header mouse click events. The
* headerClick method is called when the user presses a header column cell.
*/
public interface HeaderClickListener extends Serializable {
/**
* Called when a user clicks a header column cell
*
* @param event
* The event which contains information about the column and
* the mouse click event
*/
public void headerClick(HeaderClickEvent event);
}
/**
* Interface for the listener for column footer mouse click events. The
* footerClick method is called when the user presses a footer column cell.
*/
public interface FooterClickListener extends Serializable {
/**
* Called when a user clicks a footer column cell
*
* @param event
* The event which contains information about the column and
* the mouse click event
*/
public void footerClick(FooterClickEvent event);
}
/**
* Adds a header click listener which handles the click events when the user
* clicks on a column header cell in the Table.
*
* The listener will receive events which contain information about which
* column was clicked and some details about the mouse event.
*
*
* @param listener
* The handler which should handle the header click events.
*/
public void addHeaderClickListener(HeaderClickListener listener) {
addListener(TableConstants.HEADER_CLICK_EVENT_ID,
HeaderClickEvent.class, listener,
HeaderClickEvent.HEADER_CLICK_METHOD);
}
/**
* @deprecated As of 7.0, replaced by
* {@link #addHeaderClickListener(HeaderClickListener)}
**/
@Deprecated
public void addListener(HeaderClickListener listener) {
addHeaderClickListener(listener);
}
/**
* Removes a header click listener
*
* @param listener
* The listener to remove.
*/
public void removeHeaderClickListener(HeaderClickListener listener) {
removeListener(TableConstants.HEADER_CLICK_EVENT_ID,
HeaderClickEvent.class, listener);
}
/**
* @deprecated As of 7.0, replaced by
* {@link #removeHeaderClickListener(HeaderClickListener)}
**/
@Deprecated
public void removeListener(HeaderClickListener listener) {
removeHeaderClickListener(listener);
}
/**
* Adds a footer click listener which handles the click events when the user
* clicks on a column footer cell in the Table.
*
* The listener will receive events which contain information about which
* column was clicked and some details about the mouse event.
*
*
* @param listener
* The handler which should handle the footer click events.
*/
public void addFooterClickListener(FooterClickListener listener) {
addListener(TableConstants.FOOTER_CLICK_EVENT_ID,
FooterClickEvent.class, listener,
FooterClickEvent.FOOTER_CLICK_METHOD);
}
/**
* @deprecated As of 7.0, replaced by
* {@link #addFooterClickListener(FooterClickListener)}
**/
@Deprecated
public void addListener(FooterClickListener listener) {
addFooterClickListener(listener);
}
/**
* Removes a footer click listener
*
* @param listener
* The listener to remove.
*/
public void removeFooterClickListener(FooterClickListener listener) {
removeListener(TableConstants.FOOTER_CLICK_EVENT_ID,
FooterClickEvent.class, listener);
}
/**
* @deprecated As of 7.0, replaced by
* {@link #removeFooterClickListener(FooterClickListener)}
**/
@Deprecated
public void removeListener(FooterClickListener listener) {
removeFooterClickListener(listener);
}
/**
* Gets the footer caption beneath the rows
*
* @param propertyId
* The propertyId of the column *
* @return The caption of the footer or NULL if not set
*/
public String getColumnFooter(Object propertyId) {
return columnFooters.get(propertyId);
}
/**
* Sets the column footer caption. The column footer caption is the text
* displayed beneath the column if footers have been set visible.
*
* @param propertyId
* The properyId of the column
*
* @param footer
* The caption of the footer
*/
public void setColumnFooter(Object propertyId, String footer) {
if (footer == null) {
columnFooters.remove(propertyId);
} else {
columnFooters.put(propertyId, footer);
}
markAsDirty();
}
/**
* Sets the footer visible in the bottom of the table.
*
* The footer can be used to add column related data like sums to the bottom
* of the Table using setColumnFooter(Object propertyId, String footer).
*
*
* @param visible
* Should the footer be visible
*/
public void setFooterVisible(boolean visible) {
if (visible != columnFootersVisible) {
columnFootersVisible = visible;
markAsDirty();
}
}
/**
* Is the footer currently visible?
*
* @return Returns true if visible else false
*/
public boolean isFooterVisible() {
return columnFootersVisible;
}
/**
* This event is fired when a column is resized. The event contains the
* columns property id which was fired, the previous width of the column and
* the width of the column after the resize.
*/
public static class ColumnResizeEvent extends Component.Event {
public static final Method COLUMN_RESIZE_METHOD;
static {
try {
COLUMN_RESIZE_METHOD = ColumnResizeListener.class
.getDeclaredMethod("columnResize",
new Class[] { ColumnResizeEvent.class });
} catch (final java.lang.NoSuchMethodException e) {
// This should never happen
throw new java.lang.RuntimeException(e);
}
}
private final int previousWidth;
private final int currentWidth;
private final Object columnPropertyId;
/**
* Constructor
*
* @param source
* The source of the event
* @param propertyId
* The columns property id
* @param previous
* The width in pixels of the column before the resize event
* @param current
* The width in pixels of the column after the resize event
*/
public ColumnResizeEvent(Component source, Object propertyId,
int previous, int current) {
super(source);
previousWidth = previous;
currentWidth = current;
columnPropertyId = propertyId;
}
/**
* Get the column property id of the column that was resized.
*
* @return The column property id
*/
public Object getPropertyId() {
return columnPropertyId;
}
/**
* Get the width in pixels of the column before the resize event
*
* @return Width in pixels
*/
public int getPreviousWidth() {
return previousWidth;
}
/**
* Get the width in pixels of the column after the resize event
*
* @return Width in pixels
*/
public int getCurrentWidth() {
return currentWidth;
}
}
/**
* Interface for listening to column resize events.
*/
public interface ColumnResizeListener extends Serializable {
/**
* This method is triggered when the column has been resized
*
* @param event
* The event which contains the column property id, the
* previous width of the column and the current width of the
* column
*/
public void columnResize(ColumnResizeEvent event);
}
/**
* Adds a column resize listener to the Table. A column resize listener is
* called when a user resizes a columns width.
*
* @param listener
* The listener to attach to the Table
*/
public void addColumnResizeListener(ColumnResizeListener listener) {
addListener(TableConstants.COLUMN_RESIZE_EVENT_ID,
ColumnResizeEvent.class, listener,
ColumnResizeEvent.COLUMN_RESIZE_METHOD);
}
/**
* @deprecated As of 7.0, replaced by
* {@link #addColumnResizeListener(ColumnResizeListener)}
**/
@Deprecated
public void addListener(ColumnResizeListener listener) {
addColumnResizeListener(listener);
}
/**
* Removes a column resize listener from the Table.
*
* @param listener
* The listener to remove
*/
public void removeColumnResizeListener(ColumnResizeListener listener) {
removeListener(TableConstants.COLUMN_RESIZE_EVENT_ID,
ColumnResizeEvent.class, listener);
}
/**
* @deprecated As of 7.0, replaced by
* {@link #removeColumnResizeListener(ColumnResizeListener)}
**/
@Deprecated
public void removeListener(ColumnResizeListener listener) {
removeColumnResizeListener(listener);
}
/**
* This event is fired when a columns are reordered by the end user user.
*/
public static class ColumnReorderEvent extends Component.Event {
public static final Method METHOD;
static {
try {
METHOD = ColumnReorderListener.class.getDeclaredMethod(
"columnReorder",
new Class[] { ColumnReorderEvent.class });
} catch (final java.lang.NoSuchMethodException e) {
// This should never happen
throw new java.lang.RuntimeException(e);
}
}
/**
* Constructor
*
* @param source
* The source of the event
*/
public ColumnReorderEvent(Component source) {
super(source);
}
}
/**
* Interface for listening to column reorder events.
*/
public interface ColumnReorderListener extends Serializable {
/**
* This method is triggered when the column has been reordered
*
* @param event
*/
public void columnReorder(ColumnReorderEvent event);
}
/**
* Adds a column reorder listener to the Table. A column reorder listener is
* called when a user reorders columns.
*
* @param listener
* The listener to attach to the Table
*/
public void addColumnReorderListener(ColumnReorderListener listener) {
addListener(TableConstants.COLUMN_REORDER_EVENT_ID,
ColumnReorderEvent.class, listener, ColumnReorderEvent.METHOD);
}
/**
* @deprecated As of 7.0, replaced by
* {@link #addColumnReorderListener(ColumnReorderListener)}
**/
@Deprecated
public void addListener(ColumnReorderListener listener) {
addColumnReorderListener(listener);
}
/**
* Removes a column reorder listener from the Table.
*
* @param listener
* The listener to remove
*/
public void removeColumnReorderListener(ColumnReorderListener listener) {
removeListener(TableConstants.COLUMN_REORDER_EVENT_ID,
ColumnReorderEvent.class, listener);
}
/**
* @deprecated As of 7.0, replaced by
* {@link #removeColumnReorderListener(ColumnReorderListener)}
**/
@Deprecated
public void removeListener(ColumnReorderListener listener) {
removeColumnReorderListener(listener);
}
/**
* Set the item description generator which generates tooltips for cells and
* rows in the Table
*
* @param generator
* The generator to use or null to disable
*/
public void setItemDescriptionGenerator(ItemDescriptionGenerator generator) {
if (generator != itemDescriptionGenerator) {
itemDescriptionGenerator = generator;
// Assures the visual refresh. No need to reset the page buffer
// before as the content has not changed, only the descriptions
refreshRenderedCells();
}
}
/**
* Get the item description generator which generates tooltips for cells and
* rows in the Table.
*/
public ItemDescriptionGenerator getItemDescriptionGenerator() {
return itemDescriptionGenerator;
}
/**
* Row generators can be used to replace certain items in a table with a
* generated string. The generator is called each time the table is
* rendered, which means that new strings can be generated each time.
*
* Row generators can be used for e.g. summary rows or grouping of items.
*/
public interface RowGenerator extends Serializable {
/**
* Called for every row that is painted in the Table. Returning a
* GeneratedRow object will cause the row to be painted based on the
* contents of the GeneratedRow. A generated row is by default styled
* similarly to a header or footer row.
*
* The GeneratedRow data object contains the text that should be
* rendered in the row. The itemId in the container thus works only as a
* placeholder.
*
* If GeneratedRow.setSpanColumns(true) is used, there will be one
* String spanning all columns (use setText("Spanning text")). Otherwise
* you can define one String per visible column.
*
* If GeneratedRow.setRenderAsHtml(true) is used, the strings can
* contain HTML markup, otherwise all strings will be rendered as text
* (the default).
*
* A "v-table-generated-row" CSS class is added to all generated rows.
* For custom styling of a generated row you can combine a RowGenerator
* with a CellStyleGenerator.
*
*
* @param table
* The Table that is being painted
* @param itemId
* The itemId for the row
* @return A GeneratedRow describing how the row should be painted or
* null to paint the row with the contents from the container
*/
public GeneratedRow generateRow(Table table, Object itemId);
}
public static class GeneratedRow implements Serializable {
private boolean htmlContentAllowed = false;
private boolean spanColumns = false;
private String[] text = null;
/**
* Creates a new generated row. If only one string is passed in, columns
* are automatically spanned.
*
* @param text
*/
public GeneratedRow(String... text) {
setHtmlContentAllowed(false);
setSpanColumns(text == null || text.length == 1);
setText(text);
}
/**
* Pass one String if spanColumns is used, one String for each visible
* column otherwise
*/
public void setText(String... text) {
if (text == null || (text.length == 1 && text[0] == null)) {
text = new String[] { "" };
}
this.text = text;
}
protected String[] getText() {
return text;
}
protected Object getValue() {
return getText();
}
protected boolean isHtmlContentAllowed() {
return htmlContentAllowed;
}
/**
* If set to true, all strings passed to {@link #setText(String...)}
* will be rendered as HTML.
*
* @param htmlContentAllowed
*/
public void setHtmlContentAllowed(boolean htmlContentAllowed) {
this.htmlContentAllowed = htmlContentAllowed;
}
protected boolean isSpanColumns() {
return spanColumns;
}
/**
* If set to true, only one string will be rendered, spanning the entire
* row.
*
* @param spanColumns
*/
public void setSpanColumns(boolean spanColumns) {
this.spanColumns = spanColumns;
}
}
/**
* Assigns a row generator to the table. The row generator will be able to
* replace rows in the table when it is rendered.
*
* @param generator
* the new row generator
*/
public void setRowGenerator(RowGenerator generator) {
rowGenerator = generator;
refreshRowCache();
}
/**
* @return the current row generator
*/
public RowGenerator getRowGenerator() {
return rowGenerator;
}
/**
* Sets a converter for a property id.
*
* The converter is used to format the the data for the given property id
* before displaying it in the table.
*
*
* @param propertyId
* The propertyId to format using the converter
* @param converter
* The converter to use for the property id
*/
public void setConverter(Object propertyId, Converter converter) {
if (!getContainerPropertyIds().contains(propertyId)) {
throw new IllegalArgumentException("PropertyId " + propertyId
+ " must be in the container");
}
// FIXME: This check should be here but primitive types like Boolean
// formatter for boolean property must be handled
// if (!converter.getSourceType().isAssignableFrom(getType(propertyId)))
// {
// throw new IllegalArgumentException("Property type ("
// + getType(propertyId)
// + ") must match converter source type ("
// + converter.getSourceType() + ")");
// }
propertyValueConverters.put(propertyId,
(Converter) converter);
refreshRowCache();
}
/**
* Checks if there is a converter set explicitly for the given property id.
*
* @param propertyId
* The propertyId to check
* @return true if a converter has been set for the property id, false
* otherwise
*/
protected boolean hasConverter(Object propertyId) {
return propertyValueConverters.containsKey(propertyId);
}
/**
* Returns the converter used to format the given propertyId.
*
* @param propertyId
* The propertyId to check
* @return The converter used to format the propertyId or null if no
* converter has been set
*/
public Converter getConverter(Object propertyId) {
return propertyValueConverters.get(propertyId);
}
@Override
public void setVisible(boolean visible) {
if (visible) {
// We need to ensure that the rows are sent to the client when the
// Table is made visible if it has been rendered as invisible.
setRowCacheInvalidated(true);
}
super.setVisible(visible);
}
@Override
public Iterator iterator() {
if (visibleComponents == null) {
Collection empty = Collections.emptyList();
return empty.iterator();
}
return visibleComponents.iterator();
}
/**
* @deprecated As of 7.0, use {@link #iterator()} instead.
*/
@Deprecated
public Iterator getComponentIterator() {
return iterator();
}
private final Logger getLogger() {
if (logger == null) {
logger = Logger.getLogger(Table.class.getName());
}
return logger;
}
}