org.geebis.books.ui.faces.component
Class UINavigator

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          org.geebis.books.ui.faces.component.UINavigator

All Implemented Interfaces:

java.io.Serializable, javax.faces.component.ActionSource, javax.faces.component.StateHolder, javax.faces.component.ValueHolder

public class UINavigator
extends javax.faces.component.UIComponentBase
implements javax.faces.component.ActionSource, javax.faces.component.ValueHolder, java.io.Serializable

The UINavigator class represents a Navigator JSF control in Geebis. A Navigator control is like a toolbar, and can be customizd by the user. Elements can be reordered and hidden. The navigator can also be reset to its defaults.

See Also:

Serialized Form

Field Summary

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

Constructor Summary

UINavigator()

Method Summary

void	addActionListener(javax.faces.event.ActionListener actionListener)
void	broadcast(javax.faces.event.FacesEvent event)
javax.faces.el.MethodBinding	getAction()
javax.faces.el.MethodBinding	getActionListener()
javax.faces.event.ActionListener[]	getActionListeners()
javax.faces.convert.Converter	getConverter()
java.lang.String	getFamily()
NavigatorItemList	getItems() Gets the navigator item list for this UINavigator
java.lang.Object	getLocalValue()
boolean	getRendersChildren()
javax.faces.el.MethodBinding	getReorderAction()
NavigatorItem	getSubmittedItem() Gets the submitted navigator item for this UINavigator
java.lang.Object	getValue()
boolean	isImmediate()
void	queueEvent(javax.faces.event.FacesEvent event)
void	removeActionListener(javax.faces.event.ActionListener actionListener)
void	reorder()
void	restoreState(javax.faces.context.FacesContext context, java.lang.Object state)
java.lang.Object	saveState(javax.faces.context.FacesContext context)
void	setAction(javax.faces.el.MethodBinding methodBinding)
void	setActionListener(javax.faces.el.MethodBinding methodBinding)
void	setConverter(javax.faces.convert.Converter converter)
void	setImmediate(boolean b)
void	setItems(NavigatorItemList items) Sets the navigator item list for this UINavigator
void	setReorderAction(javax.faces.el.MethodBinding reorderAction)
void	setSubmittedItem(NavigatorItem submittedItem) Sets the submitted item for this UINavigator
void	setValue(java.lang.Object object)

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getValueBinding, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, 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 java.lang.String COMPONENT_FAMILY

COMPONENT_TYPE

public static java.lang.String COMPONENT_TYPE

Constructor Detail

UINavigator

public UINavigator()

Method Detail

getSubmittedItem

public NavigatorItem getSubmittedItem()

Gets the submitted navigator item for this UINavigator

Returns:

the submitted navigator item for this UINavigator

setSubmittedItem

public void setSubmittedItem(NavigatorItem submittedItem)

Sets the submitted item for this UINavigator

Parameters:

submittedItem - the new navigator item that is selected

getItems

public NavigatorItemList getItems()

Gets the navigator item list for this UINavigator

Returns:

the list of items in this UINavigator

setItems

public void setItems(NavigatorItemList items)

Sets the navigator item list for this UINavigator

Parameters:

items - the new navigator item list for this UINavigator

getFamily

public java.lang.String getFamily()

Specified by:

getFamily in class javax.faces.component.UIComponent

getRendersChildren

public boolean getRendersChildren()

Overrides:

getRendersChildren in class javax.faces.component.UIComponentBase

broadcast

public void broadcast(javax.faces.event.FacesEvent event)
               throws javax.faces.event.AbortProcessingException

Overrides:

broadcast in class javax.faces.component.UIComponentBase

Throws:

javax.faces.event.AbortProcessingException

queueEvent

public void queueEvent(javax.faces.event.FacesEvent event)

Overrides:

queueEvent in class javax.faces.component.UIComponentBase

saveState

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

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class javax.faces.component.UIComponentBase

restoreState

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

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class javax.faces.component.UIComponentBase

getAction

public javax.faces.el.MethodBinding getAction()

Specified by:

getAction in interface javax.faces.component.ActionSource

setAction

public void setAction(javax.faces.el.MethodBinding methodBinding)

Specified by:

setAction in interface javax.faces.component.ActionSource

getActionListener

public javax.faces.el.MethodBinding getActionListener()

Specified by:

getActionListener in interface javax.faces.component.ActionSource

setActionListener

public void setActionListener(javax.faces.el.MethodBinding methodBinding)

Specified by:

setActionListener in interface javax.faces.component.ActionSource

isImmediate

public boolean isImmediate()

Specified by:

isImmediate in interface javax.faces.component.ActionSource

setImmediate

public void setImmediate(boolean b)

Specified by:

setImmediate in interface javax.faces.component.ActionSource

addActionListener

public void addActionListener(javax.faces.event.ActionListener actionListener)

Specified by:

addActionListener in interface javax.faces.component.ActionSource

getActionListeners

public javax.faces.event.ActionListener[] getActionListeners()

Specified by:

getActionListeners in interface javax.faces.component.ActionSource

removeActionListener

public void removeActionListener(javax.faces.event.ActionListener actionListener)

Specified by:

removeActionListener in interface javax.faces.component.ActionSource

getLocalValue

public java.lang.Object getLocalValue()

Specified by:

getLocalValue in interface javax.faces.component.ValueHolder

getValue

public java.lang.Object getValue()

Specified by:

getValue in interface javax.faces.component.ValueHolder

setValue

public void setValue(java.lang.Object object)

Specified by:

setValue in interface javax.faces.component.ValueHolder

getConverter

public javax.faces.convert.Converter getConverter()

Specified by:

getConverter in interface javax.faces.component.ValueHolder

setConverter

public void setConverter(javax.faces.convert.Converter converter)

Specified by:

setConverter in interface javax.faces.component.ValueHolder

getReorderAction

public javax.faces.el.MethodBinding getReorderAction()

setReorderAction

public void setReorderAction(javax.faces.el.MethodBinding reorderAction)

reorder

public void reorder()