com.vaadin.client.ui

Class VScrollTable.FooterCell

java.lang.Object

com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.Widget

com.vaadin.client.ui.VScrollTable.FooterCell

All Implemented Interfaces:

com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.IsWidget

Direct Known Subclasses:

VScrollTable.RowHeadersFooterCell

Enclosing class:

VScrollTable

public class VScrollTable.FooterCell
extends com.google.gwt.user.client.ui.Widget

A cell in the footer

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

Field Summary

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
FooterCell(String colId, String headerText)

Method Summary

Modifier and Type	Method and Description
char	getAlign() Get the alignment of the text int the cell
String	getColKey() Returns the column key of the column
float	getExpandRatio() Returns the expand ratio of the cell
int	getNaturalColumnWidth(int columnIndex) Detects the natural minimum width for the column of this header cell.
int	getWidth() Returns the pixels width of the footer cell.
protected void	handleCaptionEvent(com.google.gwt.user.client.Event event) Handles a event on the captions
boolean	isDefinedWidth() Detects if width is fixed by developer on server side or resized to current width by user.
boolean	isEnabled() Is the cell enabled?
void	onBrowserEvent(com.google.gwt.user.client.Event event) Handle column clicking
protected void	saveNaturalColumnWidthIfNotSaved(int columnIndex) Saves natural column width if it hasn't been saved already.
void	setAlign(char c) Set alignment of the text in the cell
void	setExpandRatio(float floatAttribute) Sets the expand ratio of the cell
void	setNaturalMinimumColumnWidth(int w)
void	setText(String footerText) Sets the text of the footer
void	setUndefinedWidth() Sets the width to undefined
void	setWidth(int w, boolean ensureDefinedWidth) Sets the width of the cell.
protected void	updateStyleNames(String primaryStyleName)

Methods inherited from class com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onDetach, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

FooterCell

public FooterCell(String colId,
                  String headerText)

Method Detail

updateStyleNames

protected void updateStyleNames(String primaryStyleName)

setText

public void setText(String footerText)

Sets the text of the footer

Parameters:

footerText - The text in the footer

setAlign

public void setAlign(char c)

Set alignment of the text in the cell

Parameters:

c - The alignment which can be ALIGN_CENTER, ALIGN_LEFT, ALIGN_RIGHT

getAlign

public char getAlign()

Get the alignment of the text int the cell

Returns:

Returns either ALIGN_CENTER, ALIGN_LEFT or ALIGN_RIGHT

setWidth

public void setWidth(int w,
                     boolean ensureDefinedWidth)

Sets the width of the cell. This width should not include any possible indent modifications that are present in VScrollTable.VScrollTableBody.getMaxIndent().

Parameters:

w - The width of the cell

ensureDefinedWidth - Ensures that the given width is not recalculated

setUndefinedWidth

public void setUndefinedWidth()

Sets the width to undefined

isDefinedWidth

public boolean isDefinedWidth()

Detects if width is fixed by developer on server side or resized to current width by user.

Returns:

true if defined, false if "natural" width

getWidth

public int getWidth()

Returns the pixels width of the footer cell.

Returns:

The width in pixels

setExpandRatio

public void setExpandRatio(float floatAttribute)

Sets the expand ratio of the cell

Parameters:

floatAttribute - The expand ratio

getExpandRatio

public float getExpandRatio()

Returns the expand ratio of the cell

Returns:

The expand ratio

isEnabled

public boolean isEnabled()

Is the cell enabled?

Returns:

True if enabled else False

onBrowserEvent

public void onBrowserEvent(com.google.gwt.user.client.Event event)

Handle column clicking

Specified by:

onBrowserEvent in interface com.google.gwt.user.client.EventListener

Overrides:

onBrowserEvent in class com.google.gwt.user.client.ui.Widget

handleCaptionEvent

protected void handleCaptionEvent(com.google.gwt.user.client.Event event)

Handles a event on the captions

Parameters:

event - The event to handle

getColKey

public String getColKey()

Returns the column key of the column

Returns:

The column key

saveNaturalColumnWidthIfNotSaved

protected void saveNaturalColumnWidthIfNotSaved(int columnIndex)

Saves natural column width if it hasn't been saved already.

Parameters:

columnIndex -

Since:

7.3.9

getNaturalColumnWidth

public int getNaturalColumnWidth(int columnIndex)

Detects the natural minimum width for the column of this header cell. If column is resized by user or the width is defined by server the actual width is returned. Else the natural min width is returned.

Parameters:

columnIndex - column index hint, if -1 (unknown) it will be detected

Returns:

setNaturalMinimumColumnWidth

public void setNaturalMinimumColumnWidth(int w)