Package ch.tocco.nice2.model.form.impl.reader.handlers

Class ColumnHandler

java.lang.Object

ch.tocco.nice2.model.form.spi.reader.handler.AbstractComponentHandler<Column>

ch.tocco.nice2.model.form.impl.reader.handlers.ColumnHandler

public final class ColumnHandler
extends AbstractComponentHandler<Column>

XML handler for the 'column' tag.

Note that specifying a column tag in the xml file is not always necessary, it may be inserted automatically based on logic.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ColumnHandler.TextAlign

Field Summary

Fields inherited from class ch.tocco.nice2.model.form.spi.reader.handler.AbstractComponentHandler

displayType, field, forceEditable, label, name, receiver, scopes, useLabel

Constructor Summary

Constructors

Constructor	Description
ColumnHandler(ComponentReceiver receiver)

Method Summary

Modifier and Type	Method	Description
protected void	afterFinish()	Will be called after running the AbstractComponentHandler.finish()-Method.
protected Class<? extends Column>	getImplClass()	A concrete class which implments AbstractComponentHandler (not the handler).
protected Class<Column>	getInterface()	Return the Interface which represents this component (not the handler).
void	layoutScope(String layoutScope)
final void	setClientRenderer(String clientRenderer)
final void	setCssStyle(String cssStyle)
final void	setFixed(Boolean fixed)
final void	setJsRenderer(String jsRenderer)
final void	setNiceType(String niceType)
final void	setSortable(Boolean sortable)
final void	setTextAlign(ColumnHandler.TextAlign textAlign)
final void	setTooltip(String tooltip)
final void	setWidth(Integer width)
void	shrinkToContent(boolean shrinkToContent)
void	sticky(boolean sticky)
Object	tag(String tagName)
void	tileIcon(String tileIcon)
void	useAsTitle(boolean useAsTitle)

Methods inherited from class ch.tocco.nice2.model.form.spi.reader.handler.AbstractComponentHandler

addAttributeProps, addExtProps, beforeFinish, createOrGetComponent, disableOldClient, doFinish, finish, forceEditable, label, setDisplayType, setLabel, setName, setPosition, setScopes, setUseLabel, startElement

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ColumnHandler

public ColumnHandler(ComponentReceiver receiver)

Method Details

tag

@AnyElement
@Cardinality(min=1,
             max=2147483647)
public Object tag(@ElementName
 String tagName)
           throws ModelBuildException

Throws:

ModelBuildException

setWidth

@Attribute("width")
public final void setWidth(Integer width)
                    throws ModelBuildException

Throws:

ModelBuildException

setFixed

@Attribute("fixed")
public final void setFixed(Boolean fixed)

setSortable

@Attribute("sortable")
public final void setSortable(Boolean sortable)

setJsRenderer

@Attribute("js-renderer")
public final void setJsRenderer(String jsRenderer)
                         throws ModelBuildException

Throws:

ModelBuildException

setClientRenderer

@Attribute("client-renderer")
public final void setClientRenderer(String clientRenderer)

setNiceType

@Attribute("nice-type")
public final void setNiceType(String niceType)
                       throws ModelBuildException

Throws:

ModelBuildException

setTextAlign

@Attribute("text-align")
public final void setTextAlign(ColumnHandler.TextAlign textAlign)
                        throws ModelBuildException

Throws:

ModelBuildException

setCssStyle

@Attribute("css-style")
public final void setCssStyle(String cssStyle)
                       throws ModelBuildException

Throws:

ModelBuildException

setTooltip

@Attribute("tooltip")
public final void setTooltip(String tooltip)
                      throws ModelBuildException

Throws:

ModelBuildException

shrinkToContent

@Attribute("shrinkToContent")
public void shrinkToContent(boolean shrinkToContent)

sticky

@Attribute("sticky")
public void sticky(boolean sticky)

useAsTitle

@Attribute("use-as-title")
public void useAsTitle(boolean useAsTitle)

tileIcon

@Attribute("tile-icon")
public void tileIcon(String tileIcon)

layoutScope

@Attribute("layout-scope")
public void layoutScope(String layoutScope)

getImplClass

protected Class<? extends Column> getImplClass()

Description copied from class: AbstractComponentHandler

A concrete class which implments AbstractComponentHandler (not the handler). Expects a public-constructor which takes the parent Compononent.

Specified by:

getImplClass in class AbstractComponentHandler<Column>

Returns:

the class

getInterface

protected Class<Column> getInterface()

Description copied from class: AbstractComponentHandler

Return the Interface which represents this component (not the handler). This interface is normally AbstractComponentHandler

Specified by:

getInterface in class AbstractComponentHandler<Column>

Returns:

interface-class

afterFinish

protected void afterFinish()

Description copied from class: AbstractComponentHandler

Will be called after running the AbstractComponentHandler.finish()-Method. this.field will be ready to fill.

Overrides:

afterFinish in class AbstractComponentHandler<Column>

See Also:

• AbstractComponentHandler.beforeFinish()