org.gwt.advanced.client.ui.widget.DefaultGridRenderer Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of advanced-gwt Show documentation
Show all versions of advanced-gwt Show documentation
The set of useful GWT components
/*
* Copyright 2008-2012 Sergey Skladchikov
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.gwt.advanced.client.ui.widget;
import com.google.gwt.i18n.client.DateTimeFormat;
import com.google.gwt.user.client.DOM;
import com.google.gwt.user.client.DeferredCommand;
import com.google.gwt.user.client.Element;
import com.google.gwt.user.client.IncrementalCommand;
import com.google.gwt.user.client.ui.HTMLTable;
import com.google.gwt.user.client.ui.ListBox;
import com.google.gwt.user.client.ui.Widget;
import org.gwt.advanced.client.datamodel.Editable;
import org.gwt.advanced.client.datamodel.GridDataModel;
import org.gwt.advanced.client.ui.GridRenderer;
import org.gwt.advanced.client.ui.widget.cell.*;
import java.util.Date;
/**
* This is default grid renderer implementation that is applied by grid if there is
* no custom one specified.
*
* @author Sergey Skladchikov
* @since 1.3.0
*/
public class DefaultGridRenderer implements GridRenderer {
/** target grid instance */
private EditableGrid grid;
/**
* Creates an instance of this class and initializes the grid cell factory.
*
* @param grid is a target grid.
*/
public DefaultGridRenderer(EditableGrid grid) {
this.grid = grid;
}
/** {@inheritDoc} */
public void drawHeaders(Object[] headers) {
EditableGrid grid = getGrid();
int size = grid.getHeaderWidgets().size();
for (int i = 0; i < size; i++) {
grid.removeHeaderWidget(0);
}
int skippedColumns = 0;
for (int i = 0; i < headers.length; i++) {
String header = (String) headers[i];
if (grid.isVisible(i)) {
HeaderCell cell = getCellFactory().create(i - skippedColumns, header);
cell.displayActive(false);
} else {
skippedColumns++;
}
}
}
/** {@inheritDoc} */
public void drawContent(GridDataModel model) {
int start = model.getStartRow();
int end = model.getEndRow();
boolean empty = model.isEmpty();
if (!empty && getGrid().getRowDrawHandler() != null) {
DeferredCommand.addCommand(new DrawRowCommand(start, end));
} else {
for (int i = start; !empty && i <= end; i++)
drawRow(model.getRowData(i), i - start);
}
for (int i = getGrid().getRowCount() - 1; i >= end - start + 1; i--)
getGrid().removeRow(i);
}
/** {@inheritDoc} */
public void drawRow(Object[] data, int row) {
if (row < 0)
row = 0;
EditableGrid grid = getGrid();
for (int i = 0; i < data.length; i++) {
if (grid.isVisible(i)) {
drawCell(data[i], row, i, false);
grid.getCellFormatter().addStyleName(row, i, "grid-column");
}
}
}
/** {@inheritDoc} */
public void drawCell(Object data, int row, int column, boolean active) {
int gridColumn = getGrid().getColumnByModelColumn(column);
if (active)
getCellFactory().create(row, gridColumn, data).displayActive(true);
else {
Class columnType = grid.getColumnWidgetClasses()[column];
if (
IntegerCell.class.equals(columnType) || LongCell.class.equals(columnType)
|| DoubleCell.class.equals(columnType) || FloatCell.class.equals(columnType)
|| ShortCell.class.equals(columnType)
)
setCellText(formatString(data), row, gridColumn, "numeric-cell");
else if (ListCell.class.equals(columnType))
setCellText(getListBoxText((ListBox) data), row, gridColumn, "list-cell");
else if (DateCell.class.equals(columnType))
setCellText(formatDate((Date) data), row, gridColumn, "date-cell");
else if (TextAreaCell.class.equals(columnType))
setCellText(formatString(data).replaceAll("\n", "
"), row, gridColumn, "text-cell");
else if (LabelCell.class.equals(columnType) || TextBoxCell.class.equals(columnType))
setCellText(formatString(data), row, gridColumn, "text-cell");
else if (ImageCell.class.equals(columnType))
setCellWidget((Widget) data, row, gridColumn, "image-cell");
else
getCellFactory().create(row, gridColumn, data).displayActive(false);
}
}
/** {@inheritDoc} */
public int getModelRow(int row) {
Editable dataModel = getGrid().getModel();
return row + dataModel.getPageSize() * dataModel.getCurrentPageNumber();
}
/** {@inheritDoc} */
public int getRowByModelRow(int modelRow) {
Editable dataModel = getGrid().getModel();
return modelRow - dataModel.getPageSize() * dataModel.getCurrentPageNumber();
}
/** {@inheritDoc} */
public void drawColumn(Object[] data, int column, boolean overwrite) {
if (!overwrite && column < getGrid().getHeaderWidgets().size())
getGrid().insertHeaderCell(column);
HeaderCell cell = getCellFactory().create(column, getGrid().getHeaders()[column]);
cell.displayActive(false);
for (int i = 0; i < data.length && i < getGrid().getRowCount(); i++)
drawCell(data[i], i, column, false);
}
/**
* Getter for property 'grid'.
*
* @return Value for property 'grid'.
*/
public EditableGrid getGrid() {
return grid;
}
/**
* This method sets the cell value in textual format.
* It also decorates the cell with the specified style.
*
* @param text is a text of the cell value.
* @param row is a row number.
* @param column is a column number.
* @param style is a style name.
*/
protected void setCellText(String text, int row, int column, String style) {
getGrid().setText(row, column, text);
decorateCell(row, column, style);
}
/**
* Sets the widget into the specified cell and decorates this cell with the specified style.
*
* @param widget is a widget to set.
* @param row is a row number.
* @param column is a column number.
* @param style is a cell style.
*/
protected void setCellWidget(Widget widget, int row, int column, String style) {
getGrid().setWidget(row, column, widget);
decorateCell(row, column, style);
}
/**
* This method decorates the cell with styles.
*
* @param row is a row number.
* @param column is a column number.
* @param style is a style name.
*/
protected void decorateCell(int row, int column, String style) {
HTMLTable.CellFormatter formatter = getGrid().getCellFormatter();
formatter.setStyleName(row, column, "data-cell");
formatter.addStyleName(row, column, style);
if (getGrid().isReadOnly(column))
formatter.addStyleName(row, column, "readonly-cell");
else
formatter.addStyleName(row, column, "editable-cell");
}
/**
* This method formates the specified date.
*
* @param date is a date to be formatted.
* @return a date string.
*/
protected String formatDate (Date date) {
if (date == null)
return "";
return DateTimeFormat.getLongDateFormat().format(date);
}
/**
* This method formats the object and returns its textual representation
* If the object is null the method gets an empty string.
*
* @param data is an object to be formatted.
* @return a textual representation of the object.
*/
protected String formatString(Object data) {
if (data == null)
return "";
return String.valueOf(data);
}
/**
* This method returns a text for the inactive label.
*
* @param listBox is a list box.
*
* @return a label text.
*/
protected String getListBoxText(ListBox listBox) {
String labelText = "";
if (listBox != null) {
int index = -1;
if (listBox.getItemCount() > 0)
index = listBox.getSelectedIndex();
if (index != -1)
labelText = listBox.getItemText(index);
else if (listBox.getItemCount() > 0)
labelText = listBox.getItemText(0);
}
return labelText;
}
/**
* Getter for property 'cellFactory'.
*
* @return Value for property 'cellFactory'.
*/
protected GridCellFactory getCellFactory() {
return getGrid().getGridCellFactory();
}
/**
* This method retuns the thead element of the grid.
*
* @return a thead element.
*/
protected Element getTHeadElement() {
return getGrid().getTHeadElement();
}
/**
* This method returns a tbody element of the grid.
*
* @return a tbody element.
*/
protected Element getTBodyElement() {
return getGrid().getBodyElement();
}
/**
* This command displays one row.
*
* @author Sergey Skladchikov
*/
protected class DrawRowCommand implements IncrementalCommand {
/** start row number */
private int start;
/** end row number */
private int end;
/** current row number */
private int current;
/**
* Creates an instance of this class and initilizes internal variables.
*
* @param start is a start row number.
* @param end is an end row number.
*/
public DrawRowCommand(int start, int end) {
this.start = start;
this.end = end;
this.current = this.start;
DOM.setStyleAttribute(getGrid().getBodyElement(), "display", "none");
}
/**
* This method stops when the end row reached.
*
* @return true if drawing must be continued.
*/
public boolean execute() {
int row = getCurrent() - getStart();
int pageSize = getEnd() - getStart() + 1;
boolean cont = false;
for (int i = 0; getCurrent() <= getEnd() && i < 1; i++) {
Object[] data = getGrid().getModel().getRowData(getCurrent());
cont = getGrid().fireBeforeDrawEvent(row, pageSize, data);
if (cont) {
drawRow(data, row);
cont = getGrid().fireAfterDrawEvent(row, pageSize, data);
}
if (!cont)
break;
setCurrent(getCurrent() + 1);
}
if (!cont || getCurrent() > getEnd())
DOM.setStyleAttribute(getGrid().getBodyElement(), "display", "");
return cont && getCurrent() <= getEnd();
}
/**
* Getter for property 'start'.
*
* @return Value for property 'start'.
*/
protected int getStart() {
return start;
}
/**
* Getter for property 'end'.
*
* @return Value for property 'end'.
*/
protected int getEnd() {
return end;
}
/**
* Setter for property 'current'.
*
* @param current Value to set for property 'current'.
*/
public void setCurrent(int current) {
this.current = current;
}
/**
* Getter for property 'current'.
*
* @return Value for property 'current'.
*/
protected int getCurrent() {
return current;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy