de.tsl2.nano.bean.def.IColumn Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of tsl2.nano.descriptor Show documentation

TSL2 Framework Descriptor (currency-handling, generic formatter, descriptors for beans, collections, actions and values)

There is a newer version: 2.5.1

Show newest version

/*
 * File: $HeadURL$
 * Id  : $Id$
 * 
 * created by: Thomas Schneider
 * created on: Jan 24, 2011
 * 
 * Copyright: (c) Thomas Schneider 2011, all rights reserved
 */
package de.tsl2.nano.bean.def;

import java.text.Format;

/**
 * describes a table columns properties. should be implemented by a beanvalue class. intersects some properties of
 * IAttributeDefinition.
 * 
 * @author Thomas Schneider
 * @version $Revision$
 */
public interface IColumn extends Comparable {

    /**
     * @return Returns the columnText.
     */
    abstract String getDescription();

    /**
     * the position of that column in a table.
     * 
     * @return Returns the index.
     */
    abstract int getIndex();

    /**
     * the index of sorting - on multiple column sort.
     * 
     * @return Returns the sortIndex.
     */
    abstract int getSortIndex();

    /**
     * @return Returns the sortDirection.
     */
    abstract boolean isSortUpDirection();

    /**
     * @return Returns the pixel-width of the column.
     */
    abstract int getWidth();

    /**
     * @return Returns the attribute name.
     */
    abstract String getName();

    /**
     * @return Returns the columns format, to format a columns value.
     */
    abstract Format getFormat();

    /**
     * @return a fixed minimum search value
     */
    Comparable getMinSearchValue();
    /**
     * @return a fixed maximum search value
     */
    Comparable getMaxSearchValue();
}