org.icefaces.ace.component.dashboard

Class DashboardBase

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UIPanel

org.icefaces.ace.component.dashboard.DashboardBase

All Implemented Interfaces:

java.util.EventListener, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, IDashboard

Direct Known Subclasses:

Dashboard

public abstract class DashboardBase
extends javax.faces.component.UIPanel
implements IDashboard

The Dashboard component is a container with panes that are resizable, draggable and closable. The panes are arranged in a grid with fixed base dimensions, and they can span multiple rows and/or columns.

For more information, see the Dashboard Wiki Documentation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	DashboardBase.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
DashboardBase()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getFamily()
java.lang.Long	getLastRefresh() Return the value of the lastRefresh property.
int	getMarginX() Return the value of the marginX property.
int	getMarginY() Return the value of the marginY property.
int	getMaxColumns() Return the value of the maxColumns property.
int	getPaneHeight() Return the value of the paneHeight property.
int	getPaneWidth() Return the value of the paneWidth property.
java.lang.String	getStyle() Return the value of the style property.
java.lang.String	getStyleClass() Return the value of the styleClass property.
boolean	isDraggable() Return the value of the draggable property.
protected boolean	isPropertySet(java.lang.String finder)
boolean	isResizable() Return the value of the resizable property.
void	setDraggable(boolean draggable) Set the value of the draggable property.
void	setLastRefresh(java.lang.Long lastRefresh) Set the value of the lastRefresh property.
void	setMarginX(int marginX) Set the value of the marginX property.
void	setMarginY(int marginY) Set the value of the marginY property.
void	setMaxColumns(int maxColumns) Set the value of the maxColumns property.
void	setPaneHeight(int paneHeight) Set the value of the paneHeight property.
void	setPaneWidth(int paneWidth) Set the value of the paneWidth property.
void	setResizable(boolean resizable) Set the value of the resizable 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

addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, 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

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

DashboardBase

public DashboardBase()

Method Detail

getFamily

public java.lang.String getFamily()

Overrides:

getFamily in class javax.faces.component.UIPanel

setDraggable

public void setDraggable(boolean draggable)

Set the value of the draggable property.

Contents: Specifies whether the panes are draggable or not.

Specified by:

setDraggable in interface IDashboard

isDraggable

public boolean isDraggable()

Return the value of the draggable property.

Contents: Specifies whether the panes are draggable or not. Default = 'true'.

Specified by:

isDraggable in interface IDashboard

setMarginX

public void setMarginX(int marginX)

Set the value of the marginX property.

Contents: The size of the horizontal margins between panes, in pixels.

Specified by:

setMarginX in interface IDashboard

getMarginX

public int getMarginX()

Return the value of the marginX property.

Contents: The size of the horizontal margins between panes, in pixels. Default = '10'.

Specified by:

getMarginX in interface IDashboard

setMarginY

public void setMarginY(int marginY)

Set the value of the marginY property.

Contents: The size of the vertical margins between panes, in pixels.

Specified by:

setMarginY in interface IDashboard

getMarginY

public int getMarginY()

Return the value of the marginY property.

Contents: The size of the vertical margins between panes, in pixels. Default = '10'.

Specified by:

getMarginY in interface IDashboard

setMaxColumns

public void setMaxColumns(int maxColumns)

Set the value of the maxColumns property.

Contents: The maximum number of columns to allow in the dashboard. Valid values range from 1 to 100. Any other value will be treated as 100.

Specified by:

setMaxColumns in interface IDashboard

getMaxColumns

public int getMaxColumns()

Return the value of the maxColumns property.

Contents: The maximum number of columns to allow in the dashboard. Valid values range from 1 to 100. Any other value will be treated as 100. Default = '5'.

Specified by:

getMaxColumns in interface IDashboard

setPaneHeight

public void setPaneHeight(int paneHeight)

Set the value of the paneHeight property.

Contents: The base/minimum height of the panes in pixels, which determines the row height as well. This value can be multiplied by the pane's "sizeY" property.

Specified by:

setPaneHeight in interface IDashboard

getPaneHeight

public int getPaneHeight()

Return the value of the paneHeight property.

Contents: The base/minimum height of the panes in pixels, which determines the row height as well. This value can be multiplied by the pane's "sizeY" property. Default = '150'.

Specified by:

getPaneHeight in interface IDashboard

setPaneWidth

public void setPaneWidth(int paneWidth)

Set the value of the paneWidth property.

Contents: The base/minimum width of the panes in pixels, which determines the column width as well. This value can be multiplied by the pane's "sizeX" property.

Specified by:

setPaneWidth in interface IDashboard

getPaneWidth

public int getPaneWidth()

Return the value of the paneWidth property.

Contents: The base/minimum width of the panes in pixels, which determines the column width as well. This value can be multiplied by the pane's "sizeX" property. Default = '150'.

Specified by:

getPaneWidth in interface IDashboard

setResizable

public void setResizable(boolean resizable)

Set the value of the resizable property.

Contents: Specifies whether the panes are resizable or not.

Specified by:

setResizable in interface IDashboard

isResizable

public boolean isResizable()

Return the value of the resizable property.

Contents: Specifies whether the panes are resizable or not. Default = 'false'.

Specified by:

isResizable in interface IDashboard

setStyle

public void setStyle(java.lang.String style)

Set the value of the style property.

Contents: Style to apply to the main container element.

Specified by:

setStyle in interface IDashboard

getStyle

public java.lang.String getStyle()

Return the value of the style property.

Contents: Style to apply to the main container element.

Specified by:

getStyle in interface IDashboard

setStyleClass

public void setStyleClass(java.lang.String styleClass)

Set the value of the styleClass property.

Contents: Style class of the main container element.

Specified by:

setStyleClass in interface IDashboard

getStyleClass

public java.lang.String getStyleClass()

Return the value of the styleClass property.

Contents: Style class of the main container element.

Specified by:

getStyleClass in interface IDashboard

setLastRefresh

public void setLastRefresh(java.lang.Long lastRefresh)

Set the value of the lastRefresh property.

Specified by:

setLastRefresh in interface IDashboard

getLastRefresh

public java.lang.Long getLastRefresh()

Return the value of the lastRefresh property.

Specified by:

getLastRefresh in interface IDashboard

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