org.icefaces.ace.component.dashboard

Class DashboardPaneBase

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UIPanel

org.icefaces.ace.component.dashboard.DashboardPaneBase

All Implemented Interfaces:

java.util.EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, IceClientBehaviorHolder, IDashboardPane

Direct Known Subclasses:

DashboardPane

public abstract class DashboardPaneBase
extends javax.faces.component.UIPanel
implements IDashboardPane, IceClientBehaviorHolder

The DashboardPane component defines one of the panes of a Dashboard, which can include a header and a footer and an arbitrary number of child components and markup.

For more information, see the DashboardPane Wiki Documentation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	DashboardPaneBase.PropertyKeys

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COMPONENT_TYPE
static java.lang.String	RENDERER_TYPE

Fields inherited from class javax.faces.component.UIPanel

COMPONENT_FAMILY

Fields inherited from class javax.faces.component.UIComponent

ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY

Constructor Summary

Constructors

Constructor and Description
DashboardPaneBase()

Method Summary

Modifier and Type	Method and Description
void	addClientBehavior(java.lang.String eventName, javax.faces.component.behavior.ClientBehavior behavior)
int	getColumn() Return the value of the column property.
java.lang.String	getDefaultEventName()
java.lang.String	getDefaultExecute(java.lang.String event)
java.lang.String	getDefaultRender(java.lang.String event)
java.util.Collection<java.lang.String>	getEventNames()
java.lang.String	getFamily()
javax.faces.component.UIComponent	getFooterFacet() Return the value of the footer facet property.
java.lang.String	getFooterText() Return the value of the footerText property.
javax.faces.component.UIComponent	getHeaderFacet() Return the value of the header facet property.
java.lang.String	getHeaderText() Return the value of the headerText property.
java.lang.String	getListenerArgument(java.lang.String event)
java.lang.Integer	getOldColumn() Return the value of the oldColumn property.
java.lang.Integer	getOldRow() Return the value of the oldRow property.
java.lang.Integer	getOldSizeX() Return the value of the oldSizeX property.
java.lang.Integer	getOldSizeY() Return the value of the oldSizeY property.
int	getRow() Return the value of the row property.
int	getSizeX() Return the value of the sizeX property.
int	getSizeY() Return the value of the sizeY property.
java.lang.String	getStyle() Return the value of the style property.
java.lang.String	getStyleClass() Return the value of the styleClass property.
boolean	isClosable() Return the value of the closable property.
boolean	isClosed() Return the value of the closed property.
protected boolean	isPropertySet(java.lang.String finder)
void	setClosable(boolean closable) Set the value of the closable property.
void	setClosed(boolean closed) Set the value of the closed property.
void	setColumn(int column) Set the value of the column property.
void	setFooterFacet(javax.faces.component.UIComponent footer) Set the value of the footer facet property.
void	setFooterText(java.lang.String footerText) Set the value of the footerText property.
void	setHeaderFacet(javax.faces.component.UIComponent header) Set the value of the header facet property.
void	setHeaderText(java.lang.String headerText) Set the value of the headerText property.
void	setOldColumn(java.lang.Integer oldColumn) Set the value of the oldColumn property.
void	setOldRow(java.lang.Integer oldRow) Set the value of the oldRow property.
void	setOldSizeX(java.lang.Integer oldSizeX) Set the value of the oldSizeX property.
void	setOldSizeY(java.lang.Integer oldSizeY) Set the value of the oldSizeY property.
void	setRow(int row) Set the value of the row property.
void	setSizeX(int sizeX) Set the value of the sizeX property.
void	setSizeY(int sizeY) Set the value of the sizeY property.
void	setStyle(java.lang.String style) Set the value of the style property.
void	setStyleClass(java.lang.String styleClass) Set the value of the styleClass property.
void	setValueExpression(java.lang.String name, javax.el.ValueExpression binding)

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, visitTree

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder

getClientBehaviors

Field Detail

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

RENDERER_TYPE

public static final java.lang.String RENDERER_TYPE

See Also:

Constant Field Values

Constructor Detail

DashboardPaneBase

public DashboardPaneBase()

Method Detail

getFamily

public java.lang.String getFamily()

Overrides:

getFamily in class javax.faces.component.UIPanel

setClosable

public void setClosable(boolean closable)

Set the value of the closable property.

Contents: Specifies whether this pane can be closed or not. If true, a close button will be rendered at the upper right corner of the pane header.

Specified by:

setClosable in interface IDashboardPane

isClosable

public boolean isClosable()

Return the value of the closable property.

Contents: Specifies whether this pane can be closed or not. If true, a close button will be rendered at the upper right corner of the pane header. Default = 'false'.

Specified by:

isClosable in interface IDashboardPane

setClosed

public void setClosed(boolean closed)

Set the value of the closed property.

Contents: Specifies whether this pane is closed or not.

Specified by:

setClosed in interface IDashboardPane

isClosed

public boolean isClosed()

Return the value of the closed property.

Contents: Specifies whether this pane is closed or not. Default = 'false'.

Specified by:

isClosed in interface IDashboardPane

setColumn

public void setColumn(int column)

Set the value of the column property.

Contents: The 1-relative column position of this pane. If set to 0 or if the value is greater than "maxColumns" in the parent dashboard component, it will be given the next available horizontal position that is not already occupied by a pane with specific row and column values. If this pane overlaps with the position of another pane, this or the other pane will be automatically moved to a more appropriate available space. This value will be automatically updated as the pane changes position in the client, either directly or indirectly, by the dragStop, resize and close ajax events.

Specified by:

setColumn in interface IDashboardPane

getColumn

public int getColumn()

Return the value of the column property.

Contents: The 1-relative column position of this pane. If set to 0 or if the value is greater than "maxColumns" in the parent dashboard component, it will be given the next available horizontal position that is not already occupied by a pane with specific row and column values. If this pane overlaps with the position of another pane, this or the other pane will be automatically moved to a more appropriate available space. This value will be automatically updated as the pane changes position in the client, either directly or indirectly, by the dragStop, resize and close ajax events. Default = '0'.

Specified by:

getColumn in interface IDashboardPane

setFooterText

public void setFooterText(java.lang.String footerText)

Set the value of the footerText property.

Contents: The text to render in the footer of the pane. If no footer text is specified and no footer facet is defined, the header will not be rendered.

Specified by:

setFooterText in interface IDashboardPane

getFooterText

public java.lang.String getFooterText()

Return the value of the footerText property.

Contents: The text to render in the footer of the pane. If no footer text is specified and no footer facet is defined, the header will not be rendered.

Specified by:

getFooterText in interface IDashboardPane

setHeaderText

public void setHeaderText(java.lang.String headerText)

Set the value of the headerText property.

Contents: The text to render in the header of the pane. If no header text is specified and no header facet is defined, the header will not be rendered.

Specified by:

setHeaderText in interface IDashboardPane

getHeaderText

public java.lang.String getHeaderText()

Return the value of the headerText property.

Contents: The text to render in the header of the pane. If no header text is specified and no header facet is defined, the header will not be rendered.

Specified by:

getHeaderText in interface IDashboardPane

setRow

public void setRow(int row)

Set the value of the row property.

Contents: The 1-relative row position of this pane. If set to 0, it will be given the next available horizontal position that is not already occupied by a pane with specific row and column values. If this pane overlaps with the position of another pane, this or the other pane will be automatically moved to a more appropriate available space. This value will be automatically updated as the pane changes position in the client, either directly or indirectly, by the dragStop, resize and close ajax events.

Specified by:

setRow in interface IDashboardPane

getRow

public int getRow()

Return the value of the row property.

Contents: The 1-relative row position of this pane. If set to 0, it will be given the next available horizontal position that is not already occupied by a pane with specific row and column values. If this pane overlaps with the position of another pane, this or the other pane will be automatically moved to a more appropriate available space. This value will be automatically updated as the pane changes position in the client, either directly or indirectly, by the dragStop, resize and close ajax events. Default = '0'.

Specified by:

getRow in interface IDashboardPane

setSizeX

public void setSizeX(int sizeX)

Set the value of the sizeX property.

Contents: The horizontal size of this pane as the number columns it occupies.

Specified by:

setSizeX in interface IDashboardPane

getSizeX

public int getSizeX()

Return the value of the sizeX property.

Contents: The horizontal size of this pane as the number columns it occupies. Default = '1'.

Specified by:

getSizeX in interface IDashboardPane

setSizeY

public void setSizeY(int sizeY)

Set the value of the sizeY property.

Contents: The vertical size of the pane as the number of rows it occupies.

Specified by:

setSizeY in interface IDashboardPane

getSizeY

public int getSizeY()

Return the value of the sizeY property.

Contents: The vertical size of the pane as the number of rows it occupies. Default = '1'.

Specified by:

getSizeY in interface IDashboardPane

setStyle

public void setStyle(java.lang.String style)

Set the value of the style property.

Contents: Style to apply to the content container of the pane (i.e. excluding the header and the footer).

Specified by:

setStyle in interface IDashboardPane

getStyle

public java.lang.String getStyle()

Return the value of the style property.

Contents: Style to apply to the content container of the pane (i.e. excluding the header and the footer).

Specified by:

getStyle in interface IDashboardPane

setStyleClass

public void setStyleClass(java.lang.String styleClass)

Set the value of the styleClass property.

Contents: Style class of the main container of the pane (the one containing the header, content and footer).

Specified by:

setStyleClass in interface IDashboardPane

getStyleClass

public java.lang.String getStyleClass()

Return the value of the styleClass property.

Contents: Style class of the main container of the pane (the one containing the header, content and footer).

Specified by:

getStyleClass in interface IDashboardPane

setFooterFacet

public void setFooterFacet(javax.faces.component.UIComponent footer)

Set the value of the footer facet property.

getFooterFacet

public javax.faces.component.UIComponent getFooterFacet()

Return the value of the footer facet property.

setHeaderFacet

public void setHeaderFacet(javax.faces.component.UIComponent header)

Set the value of the header facet property.

getHeaderFacet

public javax.faces.component.UIComponent getHeaderFacet()

Return the value of the header facet property.

setOldColumn

public void setOldColumn(java.lang.Integer oldColumn)

Set the value of the oldColumn property.

Specified by:

setOldColumn in interface IDashboardPane

getOldColumn

public java.lang.Integer getOldColumn()

Return the value of the oldColumn property.

Specified by:

getOldColumn in interface IDashboardPane

setOldRow

public void setOldRow(java.lang.Integer oldRow)

Set the value of the oldRow property.

Specified by:

setOldRow in interface IDashboardPane

getOldRow

public java.lang.Integer getOldRow()

Return the value of the oldRow property.

Specified by:

getOldRow in interface IDashboardPane

setOldSizeX

public void setOldSizeX(java.lang.Integer oldSizeX)

Set the value of the oldSizeX property.

Specified by:

setOldSizeX in interface IDashboardPane

getOldSizeX

public java.lang.Integer getOldSizeX()

Return the value of the oldSizeX property.

Specified by:

getOldSizeX in interface IDashboardPane

setOldSizeY

public void setOldSizeY(java.lang.Integer oldSizeY)

Set the value of the oldSizeY property.

Specified by:

setOldSizeY in interface IDashboardPane

getOldSizeY

public java.lang.Integer getOldSizeY()

Return the value of the oldSizeY property.

Specified by:

getOldSizeY in interface IDashboardPane

isPropertySet

protected boolean isPropertySet(java.lang.String finder)

setValueExpression

public void setValueExpression(java.lang.String name,
                               javax.el.ValueExpression binding)

Overrides:

setValueExpression in class javax.faces.component.UIComponent

getEventNames

public java.util.Collection<java.lang.String> getEventNames()

Specified by:

getEventNames in interface javax.faces.component.behavior.ClientBehaviorHolder

Overrides:

getEventNames in class javax.faces.component.UIComponentBase

getDefaultEventName

public java.lang.String getDefaultEventName()

Specified by:

getDefaultEventName in interface javax.faces.component.behavior.ClientBehaviorHolder

Overrides:

getDefaultEventName in class javax.faces.component.UIComponentBase

getDefaultRender

public java.lang.String getDefaultRender(java.lang.String event)

Specified by:

getDefaultRender in interface IceClientBehaviorHolder

getDefaultExecute

public java.lang.String getDefaultExecute(java.lang.String event)

Specified by:

getDefaultExecute in interface IceClientBehaviorHolder

getListenerArgument

public java.lang.String getListenerArgument(java.lang.String event)

Specified by:

getListenerArgument in interface IceClientBehaviorHolder

addClientBehavior

public void addClientBehavior(java.lang.String eventName,
                              javax.faces.component.behavior.ClientBehavior behavior)

Specified by:

addClientBehavior in interface javax.faces.component.behavior.ClientBehaviorHolder

Overrides:

addClientBehavior in class javax.faces.component.UIComponentBase