com.inmethod.grid.common.ColumnsHeaderRepeater Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of wicketstuff-inmethod-grid Show documentation
Advanced grid components for Apache Wicket
The newest version!
package com.inmethod.grid.common;

import java.util.Collection;
import java.util.Iterator;

import org.apache.wicket.Component;
import org.apache.wicket.ajax.AjaxRequestTarget;
import org.apache.wicket.behavior.AttributeAppender;
import org.apache.wicket.markup.IMarkupFragment;
import org.apache.wicket.markup.html.WebMarkupContainer;
import org.apache.wicket.model.Model;
import org.apache.wicket.request.Response;
import org.apache.wicket.request.cycle.RequestCycle;
import org.apache.wicket.util.string.Strings;

import com.inmethod.grid.IGridColumn;
import com.inmethod.grid.IGridSortState;

/**
 * Repeater that contains column header components.
 * 
 * @param 
 *            grid model object type
 * @param 
 *            row/item model object type
 * 
 * @author Matej Knopp
 */
public abstract class ColumnsHeaderRepeater extends WebMarkupContainer
{
	private static final long serialVersionUID = 1L;

	/**
	 * Constructor.
	 * 
	 * @param id
	 */
	public ColumnsHeaderRepeater(String id)
	{
		super(id);
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	protected void onBeforeRender()
	{
		// make sure that the child components match the columns

		// remove unneeded components
		for (Iterator i = iterator(); i.hasNext();)
		{
			Component component = (Component)i.next();
			if (isComponentNeeded(component.getId()) == false)
			{
				i.remove();
			}
		}

		// create components that might be needed
		for (IGridColumn column : getActiveColumns())
		{
			String componentId = componentId(column.getId());

			if (get(componentId) == null)
			{ // if there is no component for given column, create it

				if (column.getSortProperty() == null)
				{	// for non sortable properties just add the component
					Component component = column.newHeader(componentId);
					if (component.getId().equals(componentId) == false)
					{
						throw new IllegalStateException("Invalid header component ID.");
					}
					add(component);
				}
				else
				{	// for sortable properties place the component inside SortableHeaderLinkPanel
					SortableHeaderLinkPanel panel =
                  new SortableHeaderLinkPanel(componentId, column.getSortProperty())
					{
						private static final long serialVersionUID = 1L;

						@Override
						protected void sortStateChanged(AjaxRequestTarget target)
						{
							ColumnsHeaderRepeater.this.sortStateChanged(target);
						}
					};
					Component component = column.newHeader(SortableHeaderLinkPanel.COMPONENT_ID);
					if (component.getId().equals(SortableHeaderLinkPanel.COMPONENT_ID) == false)
					{
						throw new IllegalStateException("Invalid header component ID.");
					}
					panel.add(component);
					add(panel);
				}
			}
      if (column.getWrapText() )
      {
        get(componentId)
          .add(new AttributeAppender("style",
                                     Model.of("white-space: normal;"), "; "));
      }
		}
		super.onBeforeRender();
	}

	abstract protected void sortStateChanged(AjaxRequestTarget target);

	private GridSortState getSortState()
	{
		return findParent(AbstractGrid.class).getSortState();
	}

	/**
	 * Returns the sort direction for this panel.
	 * 
	 * @return
	 */
	private IGridSortState.Direction getSortDirection(IGridColumn column)
	{
		IGridSortState state = getSortState();
		// we are interested only in the column with highest priority and it must match this panel's
    // sort property
		if (state.getColumns().size() > 0 &&
			state.getColumns().get(0).getPropertyName().equals(column.getSortProperty()))
		{
			return state.getColumns().get(0).getDirection();
		}
		else
		{
			return null;
		}
	}

	@Override
	protected void onRender()
	{
		Response response = RequestCycle.get().getResponse();

		Collection> columns = getActiveColumns();

		for (IGridColumn column : columns)
		{
			// render the table header opening tag with proper width
			response.write("");

			// render the inner divs
			response.write("");
			response.write("");

			// render the actual component
			Component component = get(componentId(column.getId()));
			if (component == null)
			{
				throw new IllegalStateException("Column ID has changed during rendering");
			}
			IMarkupFragment componentMarkup = component.getParent().getMarkup();
			component.setMarkup(componentMarkup);
			component.render();

			// render closing tag
			response.write("");

			// if resizable, render the handle
			if (column.isResizable())
			{
				response.write("");
			}
			response.write("");
		}
	}

	/**
	 * Returns whether a component with given is needed for any of the columns.
	 * 
	 * @param componentId
	 * @return
	 */
	private boolean isComponentNeeded(final String componentId)
	{
		for (IGridColumn column : getActiveColumns())
		{
			if (componentId(column.getId()).equals(componentId))
			{
				return true;
			}
		}
		return false;
	}

	private String componentId(String columnId)
	{
		return columnId.replace(".", "-");
	}

	abstract Collection> getActiveColumns();

	abstract int getColumnWidth(IGridColumn column);
}