org.wicketstuff.kendo.ui.datatable.column.AbstractColumn Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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.wicketstuff.kendo.ui.datatable.column;
import java.util.Collections;
import java.util.List;
import org.apache.wicket.model.IModel;
import org.apache.wicket.model.Model;
import org.apache.wicket.util.lang.Generics;
import org.wicketstuff.jquery.core.Options;
import org.wicketstuff.jquery.core.utils.BuilderUtils;
import org.wicketstuff.kendo.ui.datatable.editor.IKendoEditor;
import com.github.openjson.JSONObject;
/**
* Base class for {@link IColumn}{@code s} implementation
*
* @author Sebastien Briquet - sebfz1
*/
public abstract class AbstractColumn implements IColumn
{
private static final long serialVersionUID = 1L;
/** Default width. */
static final int WIDTH = -1;
private final String field;
private final Integer width;
private final IModel titleModel;
// TODO: add locked & lockable
/**
* Constructor
*
* @param title the text of the column header
*/
protected AbstractColumn(String title)
{
this(Model.of(title), null, WIDTH);
}
/**
* Constructor
*
* @param title the text of the column header
* @param width the desired width of the column
*/
protected AbstractColumn(String title, int width)
{
this(Model.of(title), null, width);
}
/**
* Constructor
*
* @param title the text of the column header
* @param field the object field name
*/
protected AbstractColumn(String title, String field)
{
this(Model.of(title), field, WIDTH);
}
/**
* Constructor
*
* @param title the text of the column header
* @param field the object field name
* @param width the desired width of the column
*/
protected AbstractColumn(String title, String field, int width)
{
this(Model.of(title), field, width);
}
/**
* Constructor
*
* @param title the text of the column header
*/
protected AbstractColumn(IModel title)
{
this(title, null, WIDTH);
}
/**
* Constructor
*
* @param title the text of the column header
* @param width the desired width of the column
*/
protected AbstractColumn(IModel title, int width)
{
this(title, null, width);
}
/**
* Constructor
*
* @param title the text of the column header
* @param field the object field name
*/
protected AbstractColumn(IModel title, String field)
{
this(title, field, WIDTH);
}
/**
* Constructor
*
* @param title the text of the column header
* @param field the object field name
* @param width the desired width of the column
*/
protected AbstractColumn(IModel title, String field, int width)
{
this.titleModel = title;
this.field = field;
this.width = width;
}
@Override
public String getTitle()
{
return this.titleModel.getObject();
}
@Override
public String getField()
{
return this.field;
}
@Override
public int getWidth()
{
return this.width;
}
@Override
public int getMinScreenWidth()
{
return 0;
}
/**
* Indicates whether the column is visible
*
* @return {@code true} by default
*/
public boolean isVisible()
{
return true;
}
@Override
public Boolean isEncoded()
{
return null;
}
@Override
public Boolean isSelectable() {
return null;
}
@Override
public IKendoEditor getEditor()
{
return null;
}
@Override
public String getFormat()
{
return null;
}
@Override
public String getTemplate()
{
return null;
}
@Override
public String getAttributes()
{
return null;
}
@Override
public String getFooterTemplate()
{
return null;
}
@Override
public String getFilterable()
{
return null;
}
@Override
public String getMenu()
{
return null;
}
@Override
public List getAggregates()
{
return Collections.emptyList();
}
/**
* Gets the list of {@code aggregates} as json array
*
* @return the list of {@code aggregates} as json array
*/
protected final String getAggregatesAsString()
{
List aggregates = Generics.newArrayList();
for (String aggregate : this.getAggregates())
{
aggregates.add(Options.asString(aggregate));
}
return aggregates.toString();
}
@Override
public String getGroupHeaderTemplate()
{
return null;
}
@Override
public String getGroupFooterTemplate()
{
return null;
}
// schema model //
@Override
public Boolean isEditable()
{
return null;
}
@Override
public Boolean isNullable()
{
return null;
}
@Override
public String getType()
{
return null;
}
/**
* Indicates whether the column/field is visible in popup-mode
* Warning: the field should *still* be editable
*
* @return {@link #isVisible()} by default;
*/
public Boolean isPopupVisible()
{
return this.isVisible();
}
// Methods //
@Override
public String toString()
{
// TODO replace StringBuilder
StringBuilder builder = new StringBuilder();
BuilderUtils.append(builder, "title", this.getTitle());
builder.append(", ");
BuilderUtils.append(builder, "hidden", !this.isVisible());
if (this.getWidth() > 0)
{
builder.append(", ");
BuilderUtils.append(builder, "width", this.getWidth());
}
if (this.getMinScreenWidth() > 0)
{
builder.append(", ");
BuilderUtils.append(builder, "minScreenWidth", this.getMinScreenWidth());
}
// nullable options (string) //
if (this.getField() != null)
{
builder.append(", ");
BuilderUtils.append(builder, "field", this.getField());
}
if (this.getFormat() != null)
{
builder.append(", ");
BuilderUtils.append(builder, "format", this.getFormat());
}
if (this.getTemplate() != null)
{
builder.append(", ");
BuilderUtils.append(builder, "template", this.getTemplate());
}
if (this.getAttributes() != null)
{
builder.append(", ");
builder.append(JSONObject.quote("attributes")).append(": ").append(this.getAttributes()); // caution, not a String value
}
if (this.getFooterTemplate() != null)
{
builder.append(", ");
BuilderUtils.append(builder, "footerTemplate", this.getFooterTemplate());
}
if (this.getGroupHeaderTemplate() != null)
{
builder.append(", ");
BuilderUtils.append(builder, "groupHeaderTemplate", this.getGroupHeaderTemplate());
}
if (this.getGroupFooterTemplate() != null)
{
builder.append(", ");
BuilderUtils.append(builder, "groupFooterTemplate", this.getGroupFooterTemplate());
}
// nullable options (function) //
if (this.getEditor() != null)
{
builder.append(", ");
builder.append(Options.QUOTE).append("editor").append(Options.QUOTE).append(": ").append(this.getEditor());
}
// nullable options (object) //
if (this.isEncoded() != null)
{
builder.append(", ");
BuilderUtils.append(builder, "encoded", this.isEncoded());
}
if (this.isEditable() != null)
{
builder.append(", ");
builder.append(Options.QUOTE).append("editable").append(Options.QUOTE).append(": function(dataItem) { return ").append(this.isEditable()).append("; }");
}
if (this.isSelectable() != null)
{
builder.append(", ");
BuilderUtils.append(builder, "selectable", this.isSelectable());
}
if (this.isPopupVisible() != null)
{
builder.append(", ");
BuilderUtils.append(builder, "popupVisible", this.isPopupVisible());
}
if (this.getMenu() != null)
{
builder.append(", ");
builder.append(Options.QUOTE).append("menu").append(Options.QUOTE).append(": ").append(this.getMenu());
}
if (!this.getAggregates().isEmpty())
{
builder.append(", ");
builder.append(Options.QUOTE).append("aggregates").append(Options.QUOTE).append(": ").append(this.getAggregatesAsString());
}
if (this.getFilterable() != null)
{
builder.append(", ");
builder.append(Options.QUOTE).append("filterable").append(Options.QUOTE).append(": ").append(this.getFilterable());
}
return builder.toString();
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy