org.apache.myfaces.custom.dojolayouts
Class FloatingPaneBase

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UIOutput
              org.apache.myfaces.custom.dojolayouts.AbstractFloatingPaneBase
                  org.apache.myfaces.custom.dojolayouts.FloatingPaneBase

All Implemented Interfaces:

javax.faces.component.StateHolder, javax.faces.component.ValueHolder, org.apache.myfaces.component.StyleAware, org.apache.myfaces.custom.dojo.DojoWidget

public class FloatingPaneBase
extends AbstractFloatingPaneBase

Field Summary

static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static java.lang.String	DEFAULT_RENDERER_TYPE

Constructor Summary

FloatingPaneBase()

Method Summary

java.lang.Boolean	getConstrainToContainer() limit to parent container
java.lang.Boolean	getDisplayCloseAction() if true a close button is displayed
java.lang.Boolean	getDisplayMinimizeAction() if true a minimize button is displayed
java.lang.String	getFamily()
java.lang.Boolean	getHasShadow() Shadow drawn or not
java.lang.String	getIconSrc() The pane icon source
java.lang.Boolean	getModal() Description for the attribute
java.lang.Boolean	getResizable() Window resizable
java.lang.String	getStyle() The CSS class for this element.
java.lang.String	getStyleClass() The CSS class for this element.
java.lang.String	getTaskBarId() The taskbar id
java.lang.String	getTitle() the floating pane Title
java.lang.Boolean	getTitleBarDisplay() Displays the title bar of the Window
java.lang.String	getWidgetId() Optional enforced dojo widgetId
java.lang.String	getWidgetVar() optional widget var name, if this is not used only an autogenerated value is set
java.lang.String	getWindowState() Display state of the window
void	restoreState(javax.faces.context.FacesContext facesContext, java.lang.Object state)
java.lang.Object	saveState(javax.faces.context.FacesContext facesContext)
void	setConstrainToContainer(java.lang.Boolean constrainToContainer)
void	setDisplayCloseAction(java.lang.Boolean displayCloseAction)
void	setDisplayMinimizeAction(java.lang.Boolean displayMinimizeAction)
void	setHasShadow(java.lang.Boolean hasShadow)
void	setIconSrc(java.lang.String iconSrc)
void	setModal(java.lang.Boolean modal)
void	setResizable(java.lang.Boolean resizable)
void	setStyle(java.lang.String style)
void	setStyleClass(java.lang.String styleClass)
void	setTaskBarId(java.lang.String taskBarId)
void	setTitle(java.lang.String title)
void	setTitleBarDisplay(java.lang.Boolean titleBarDisplay)
void	setWidgetId(java.lang.String widgetId)
void	setWidgetVar(java.lang.String widgetVar)
void	setWindowState(java.lang.String windowState)

Methods inherited from class javax.faces.component.UIOutput

getConverter, getLocalValue, getValue, setConverter, setValue

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

Methods inherited from class java.lang.Object

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

Field Detail

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY

See Also:

Constant Field Values

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

DEFAULT_RENDERER_TYPE

public static final java.lang.String DEFAULT_RENDERER_TYPE

See Also:

Constant Field Values

Constructor Detail

FloatingPaneBase

public FloatingPaneBase()

Method Detail

getFamily

public java.lang.String getFamily()

Overrides:

getFamily in class javax.faces.component.UIOutput

getConstrainToContainer

public java.lang.Boolean getConstrainToContainer()

Description copied from class: AbstractFloatingPaneBase

limit to parent container

Specified by:

getConstrainToContainer in class AbstractFloatingPaneBase

setConstrainToContainer

public void setConstrainToContainer(java.lang.Boolean constrainToContainer)

getDisplayCloseAction

public java.lang.Boolean getDisplayCloseAction()

Description copied from class: AbstractFloatingPaneBase

if true a close button is displayed

Specified by:

getDisplayCloseAction in class AbstractFloatingPaneBase

setDisplayCloseAction

public void setDisplayCloseAction(java.lang.Boolean displayCloseAction)

getDisplayMinimizeAction

public java.lang.Boolean getDisplayMinimizeAction()

Description copied from class: AbstractFloatingPaneBase

if true a minimize button is displayed

Specified by:

getDisplayMinimizeAction in class AbstractFloatingPaneBase

setDisplayMinimizeAction

public void setDisplayMinimizeAction(java.lang.Boolean displayMinimizeAction)

getHasShadow

public java.lang.Boolean getHasShadow()

Description copied from class: AbstractFloatingPaneBase

Shadow drawn or not

Specified by:

getHasShadow in class AbstractFloatingPaneBase

setHasShadow

public void setHasShadow(java.lang.Boolean hasShadow)

getIconSrc

public java.lang.String getIconSrc()

Description copied from class: AbstractFloatingPaneBase

The pane icon source

Specified by:

getIconSrc in class AbstractFloatingPaneBase

setIconSrc

public void setIconSrc(java.lang.String iconSrc)

getModal

public java.lang.Boolean getModal()

Description copied from class: AbstractFloatingPaneBase

Description for the attribute

Specified by:

getModal in class AbstractFloatingPaneBase

setModal

public void setModal(java.lang.Boolean modal)

getResizable

public java.lang.Boolean getResizable()

Description copied from class: AbstractFloatingPaneBase

Window resizable

Specified by:

getResizable in class AbstractFloatingPaneBase

setResizable

public void setResizable(java.lang.Boolean resizable)

getTaskBarId

public java.lang.String getTaskBarId()

Description copied from class: AbstractFloatingPaneBase

The taskbar id

Specified by:

getTaskBarId in class AbstractFloatingPaneBase

setTaskBarId

public void setTaskBarId(java.lang.String taskBarId)

getTitle

public java.lang.String getTitle()

Description copied from class: AbstractFloatingPaneBase

the floating pane Title

Specified by:

getTitle in class AbstractFloatingPaneBase

setTitle

public void setTitle(java.lang.String title)

getTitleBarDisplay

public java.lang.Boolean getTitleBarDisplay()

Description copied from class: AbstractFloatingPaneBase

Displays the title bar of the Window

Specified by:

getTitleBarDisplay in class AbstractFloatingPaneBase

setTitleBarDisplay

public void setTitleBarDisplay(java.lang.Boolean titleBarDisplay)

getWidgetId

public java.lang.String getWidgetId()

Description copied from class: AbstractFloatingPaneBase

Optional enforced dojo widgetId

Specified by:

getWidgetId in interface org.apache.myfaces.custom.dojo.DojoWidget

Specified by:

getWidgetId in class AbstractFloatingPaneBase

setWidgetId

public void setWidgetId(java.lang.String widgetId)

getWidgetVar

public java.lang.String getWidgetVar()

Description copied from class: AbstractFloatingPaneBase

optional widget var name, if this is not used only an autogenerated value is set

Specified by:

getWidgetVar in interface org.apache.myfaces.custom.dojo.DojoWidget

Specified by:

getWidgetVar in class AbstractFloatingPaneBase

setWidgetVar

public void setWidgetVar(java.lang.String widgetVar)

getWindowState

public java.lang.String getWindowState()

Description copied from class: AbstractFloatingPaneBase

Display state of the window

Specified by:

getWindowState in class AbstractFloatingPaneBase

setWindowState

public void setWindowState(java.lang.String windowState)

getStyle

public java.lang.String getStyle()

Description copied from class: AbstractFloatingPaneBase

The CSS class for this element. Corresponds to the HTML 'class' attribute.

Specified by:

getStyle in interface org.apache.myfaces.component.StyleAware

Specified by:

getStyle in class AbstractFloatingPaneBase

setStyle

public void setStyle(java.lang.String style)

getStyleClass

public java.lang.String getStyleClass()

Description copied from class: AbstractFloatingPaneBase

The CSS class for this element. Corresponds to the HTML 'class' attribute.

Specified by:

getStyleClass in interface org.apache.myfaces.component.StyleAware

Specified by:

getStyleClass in class AbstractFloatingPaneBase

setStyleClass

public void setStyleClass(java.lang.String styleClass)

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext facesContext)

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class javax.faces.component.UIOutput

restoreState

public void restoreState(javax.faces.context.FacesContext facesContext,
                         java.lang.Object state)

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class javax.faces.component.UIOutput