com.inmethod.grid.column.AbstractColumn Maven / Gradle / Ivy
Show all versions of wicketstuff-inmethod-grid Show documentation
package com.inmethod.grid.column;
import org.apache.wicket.Component;
import org.apache.wicket.extensions.markup.html.repeater.data.sort.ISortState;
import org.apache.wicket.markup.ComponentTag;
import org.apache.wicket.markup.html.WebMarkupContainer;
import org.apache.wicket.markup.html.basic.Label;
import org.apache.wicket.model.IModel;
import com.inmethod.grid.IGridColumn;
import com.inmethod.grid.IRenderable;
import com.inmethod.grid.SizeUnit;
import com.inmethod.grid.common.AbstractGrid;
/**
* Convenience implementation of {@link IGridColumn}. This class should be used as base for
* non-lightweight columns.
*
* Contains getters and setters for most properties and takes care of the header component. The only
* method necessary to implement is {@link #newCell(WebMarkupContainer, String, IModel)}.
*
*
* @param
* grid model object type
* @param
* row/item model object type
*
* @see AbstractLightWeightColumn
* @author Matej Knopp
*/
public abstract class AbstractColumn implements IGridColumn
{
private static final long serialVersionUID = 1L;
private final String columnId;
private final IModel headerModel;
private IModel headerTooltipModel;
private final S sortProperty;
/**
* Creates instance with specified column id, header model and sort property.
*
* @param columnId
* column identifier - must be unique within the grid
* @param headerModel
* model for column title
* @param sortProperty
* optional string that will be returned by {@link ISortState} to indicate that the
* column is being sorted
*/
public AbstractColumn(String columnId, IModel headerModel, S sortProperty)
{
this.columnId = columnId;
this.headerModel = headerModel;
this.sortProperty = sortProperty;
}
/**
* Creates instance with specified column id and header model
*
* @param columnId
* column identifier - must be unique within the grid
* @param headerModel
* model for column title
*/
public AbstractColumn(String columnId, IModel headerModel)
{
this(columnId, headerModel, null);
}
/**
* Sets the model for header tooltip.
*
* @param headerTooltipModel
* model for header tooltip
* @return this (useful for method chaining)
*/
public AbstractColumn setHeaderTooltipModel(IModel headerTooltipModel)
{
this.headerTooltipModel = headerTooltipModel;
return this;
}
/**
* Returns the model for header tooltip
*
* @return model for header tooltip
*/
public IModel getHeaderTooltipModel()
{
return headerTooltipModel;
}
/**
* Returns the model for header (caption)
*
* @return header model
*/
public IModel getHeaderModel()
{
return headerModel;
}
/**
* {@inheritDoc}
*/
public String getCellCssClass(IModel rowModel, int rowNum)
{
return null;
}
/**
* {@inheritDoc}
*/
public int getColSpan(IModel rowModel)
{
return 1;
}
/**
* {@inheritDoc}
*/
public String getHeaderCssClass()
{
return null;
}
/**
* {@inheritDoc}
*/
public String getId()
{
return columnId;
}
private int initialSize = 150;
/**
* Sets the initial size for this column. The unit depends on {@link #setSizeUnit(SizeUnit)}. By
* default the unit is pixels.
*
* @param initialSize
* initial size of the column
* @return this (useful for method chaining)
*/
public AbstractColumn setInitialSize(int initialSize)
{
this.initialSize = initialSize;
return this;
}
/**
* {@inheritDoc}
*/
public int getInitialSize()
{
return initialSize;
}
private SizeUnit sizeUnit = SizeUnit.PX;
/**
* Sets the size unit for this column. The default size unit is {@link SizeUnit#PX}.
*
* @param sizeUnit
* @return this (useful for method chaining)
*/
public AbstractColumn setSizeUnit(SizeUnit sizeUnit)
{
this.sizeUnit = sizeUnit;
return this;
}
/**
* {@inheritDoc}
*/
public SizeUnit getSizeUnit()
{
return sizeUnit;
}
private int maxSize = 0;
/**
* Sets the maximal size of this column. Only relevant if the column is resizable and the column
* unit is {@link SizeUnit#PX} (pixels).
*
* @param maxSize
* maximal column size
* @return this (useful for method chaining)
*/
public AbstractColumn setMaxSize(int maxSize)
{
this.maxSize = maxSize;
return this;
}
/**
* {@inheritDoc}
*/
public int getMaxSize()
{
return maxSize;
}
private int minSize = 0;
/**
* Sets the minimal size of this column. Only relevant if the column is resizable and the column
* unit is {@link SizeUnit#PX} (pixels).
*
* @param minSize
* minimal column size
* @return this (useful for method chaining)
*/
public AbstractColumn setMinSize(int minSize)
{
this.minSize = minSize;
return this;
}
/**
* {@inheritDoc}
*/
public int getMinSize()
{
return minSize;
}
/**
* {@inheritDoc}
*/
public S getSortProperty()
{
return sortProperty;
}
private boolean reorderable = true;
/**
* Sets whether the user will be able to drag and reorder this column (true by default).
*
* @param reorderable
* true if the column will be reorderable, false otherwise
* @return this (useful for method chaining)
*/
public AbstractColumn setReorderable(boolean reorderable)
{
this.reorderable = reorderable;
return this;
}
/**
* #see {@link IGridColumn#isReorderable()}
*/
public boolean isReorderable()
{
return reorderable;
}
private boolean resizable = true;
/**
* Sets whether the user will be able to resize this column (true by default). In order for the
* column to be resizable, the size unit must be {@link SizeUnit#PX}.
*
* @see #setSizeUnit(SizeUnit)
* @param resizable
* true if the column will be resizable, false otherwise
* @return this (useful for method chaining)
*/
public AbstractColumn setResizable(boolean resizable)
{
this.resizable = resizable;
return this;
}
/**
* {@inheritDoc}
*/
public boolean isResizable()
{
return resizable;
}
/**
* {@inheritDoc}
*/
public boolean isLightWeight(IModel rowModel)
{
return false;
}
/**
* {@inheritDoc}
*/
public abstract Component newCell(WebMarkupContainer parent, String componentId,
IModel rowModel);
/**
* {@inheritDoc}
*/
public IRenderable newCell(IModel rowModel)
{
return null;
}
/**
* {@inheritDoc}
*/
public Component newHeader(String componentId)
{
return new Label(componentId, getHeaderModel())
{
private static final long serialVersionUID = 1L;
@Override
protected void onComponentTag(ComponentTag tag)
{
super.onComponentTag(tag);
if (getHeaderTooltipModel() != null)
{
Object object = getHeaderTooltipModel().getObject();
if (object != null)
{
tag.put("title", object.toString());
}
}
}
};
}
/**
* {@inheritDoc}
*/
public void detach()
{
}
private AbstractGrid grid = null;
/**
* {@inheritDoc}
*/
public void setGrid(AbstractGrid grid)
{
if (this.grid != null && this.grid != grid)
{
throw new IllegalStateException(
"One column instance can not be used with multiple grid instances.");
}
this.grid = grid;
}
/**
* Returns the grid instance associated with this column.
*
* @return grid instance
*/
public AbstractGrid getGrid()
{
return grid;
}
private boolean wrapText = false;
/**
* Sets whether the text in column will be wrapped when it is too long to fit the column (
* false by default).
*
* @param wrapText
* true if the text will be wrapped, false otherwise.
* @return this (useful for method chaining)
*/
public AbstractColumn setWrapText(boolean wrapText)
{
this.wrapText = wrapText;
return this;
}
/**
* {@inheritDoc}
*/
public boolean getWrapText()
{
return wrapText;
}
/**
* {@inheritDoc}
*/
public boolean cellClicked(IModel rowModel)
{
return false;
}
}