org.gwt.advanced.client.ui.widget.cell.AbstractCell Maven / Gradle / Ivy
Show all versions of advanced-gwt Show documentation
/*
* 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.cell;
import com.google.gwt.event.dom.client.BlurHandler;
import com.google.gwt.event.dom.client.HasBlurHandlers;
import com.google.gwt.user.client.ui.FlexTable;
import com.google.gwt.user.client.ui.Label;
import com.google.gwt.user.client.ui.SimplePanel;
import com.google.gwt.user.client.ui.Widget;
import org.gwt.advanced.client.ui.widget.EditableGrid;
/**
* This is an sbtract cell implementation.
* All existing cells extend this class.
*
* @author Sergey Skladchikov
* @since 1.0.0
*/
public abstract class AbstractCell extends SimplePanel implements GridCell {
/** default cell focus listener */
private static BlurHandler defaultBlurHandler = new CellBlurHandler();
/** cell value */
private Object value;
/** row number */
private int row;
/** column number */
private int column;
/** grid instance which the cell belongs to */
private FlexTable grid;
/** active status flag */
private boolean active;
/** label instance to be used in most cell extensions */
private Label label;
/** a flag meaning that the default focus listener has been added */
private boolean defaultFocusListenerAdded;
/** {@inheritDoc} */
public Object getValue () {
return value;
}
/** {@inheritDoc} */
public void setValue (Object value) {
this.value = value;
}
/** {@inheritDoc} */
public void setPosition (int row, int column) {
this.row = row;
this.column = column;
}
/** {@inheritDoc} */
public int getRow () {
return row;
}
/** {@inheritDoc} */
public int getColumn () {
return column;
}
/** {@inheritDoc} */
public FlexTable getGrid () {
return grid;
}
/** {@inheritDoc} */
public void setGrid (FlexTable grid) {
this.grid = grid;
}
/** {@inheritDoc} */
public boolean isActive () {
return active;
}
/** {@inheritDoc} */
public void displayActive(boolean active) {
if (getStyleName() == null || "".equals(getStyleName()))
setStyleName("data-cell");
if (active && !isActive()) {
setActive(true);
removeStyleName("passive-cell");
addStyleName("active-cell");
Widget widget = createActive();
prepare(widget);
addListeners(widget);
setFocus(true);
} else if (!active) {
if (isActive())
removeListeners(getWidget());
setActive(false);
removeStyleName("active-cell");
addStyleName("passive-cell");
prepare(createInactive());
((EditableGrid)getGrid()).setFocus(true);
}
FlexTable grid = getGrid();
if (grid instanceof EditableGrid && !((EditableGrid) grid).isReadOnly(getColumn())) {
removeStyleName("readonly-cell");
addStyleName("editable-cell");
} else {
removeStyleName("editable-cell");
addStyleName("readonly-cell");
}
}
/** {@inheritDoc} */
public boolean valueEqual (Object value) {
Object thisValue = getValue();
return thisValue == value || thisValue != null && thisValue.equals(value);
}
/** {@inheritDoc} */
@Override
public boolean canBeDeactivated() {
return true;
}
/**
* This method creates an active cell element (content).
*
* @return a content element.
*/
protected abstract Widget createActive ();
/**
* This method creates an inactive cell element (content).
*
* @return a content element.
*/
protected abstract Widget createInactive ();
/**
* Setter for property 'active'.
*
* @param active Value to set for property 'active'.
*/
protected void setActive (boolean active) {
this.active = active;
}
/**
* This method prepares a cell before displaying it.
*
* @param widget is a content widget.
*/
protected void prepare(Widget widget) {
FlexTable grid = getGrid();
int row = getRow();
int column = getColumn();
if (getWidget() != null)
remove(getWidget());
add(widget);
Widget current = null;
if (row < grid.getRowCount() && column < grid.getCellCount(row))
current = grid.getWidget(row, column);
if (current != this)
grid.setWidget(row, column, this);
}
/**
* This method adds default listeners to the content widget.
*
* @param widget is a content widget.
*/
protected void addListeners(Widget widget) {
if (widget instanceof HasBlurHandlers && !isDefaultFocusListenerAdded()) {
((HasBlurHandlers)widget).addBlurHandler(getDefaultBlurHandler());
defaultFocusListenerAdded = true;
}
}
/**
* This method removes default listeners from the content widget.
*
* @param widget is a content widget.
*/
protected void removeListeners(Widget widget) {
}
/**
* Getter for property 'label'.
*
* @return Value for property 'label'.
*/
protected Label getLabel () {
if (label == null)
setLabel(new Label());
return label;
}
/**
* Setter for property 'label'.
*
* @param label Value to set for property 'label'.
*/
protected void setLabel (Label label) {
this.label = label;
}
/**
* Getter for property 'defaultBlurHandler'.
*
* @return Value for property 'defaultBlurHandler'.
*/
protected BlurHandler getDefaultBlurHandler() {
return defaultBlurHandler;
}
/**
* Getter for property 'defaultFocusListenerAdded'.
*
* @return Value for property 'defaultFocusListenerAdded'.
*/
protected boolean isDefaultFocusListenerAdded() {
return defaultFocusListenerAdded;
}
}