org.icefaces.mobi.component.viewmanager

Class ViewBase

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

org.icefaces.mobi.component.viewmanager.ViewBase

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, IView

Direct Known Subclasses:

View

public abstract class ViewBase
extends javax.faces.component.UIComponentBase
implements IView

Nested Class Summary

Nested Classes

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

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getDivider() Return the value of the divider property.
java.lang.String	getFamily()
java.lang.String	getMenuIcon() Return the value of the menuIcon property.
java.lang.String	getNavBarGroup() Return the value of the navBarGroup property.
java.lang.String	getStyle() Return the value of the style property.
java.lang.String	getStyleClass() Return the value of the styleClass property.
java.lang.String	getTitle() Return the value of the title property.
boolean	isIncludeInMenu() Return the value of the includeInMenu property.
protected boolean	isPropertySet(java.lang.String finder)
boolean	isSplash() Return the value of the splash property.
void	setDivider(java.lang.String divider) Set the value of the divider property.
void	setIncludeInMenu(boolean includeInMenu) Set the value of the includeInMenu property.
void	setMenuIcon(java.lang.String menuIcon) Set the value of the menuIcon property.
void	setNavBarGroup(java.lang.String navBarGroup) Set the value of the navBarGroup property.
void	setSplash(boolean splash) Set the value of the splash 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	setTitle(java.lang.String title) Set the value of the title 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

ViewBase

public ViewBase()

Method Detail

getFamily

public java.lang.String getFamily()

Specified by:

getFamily in class javax.faces.component.UIComponent

setDivider

public void setDivider(java.lang.String divider)

Set the value of the divider property.

Contents: The title of the group divider that will be rendered before the menu item for this view.

Specified by:

setDivider in interface IView

getDivider

public java.lang.String getDivider()

Return the value of the divider property.

Contents: The title of the group divider that will be rendered before the menu item for this view.

Specified by:

getDivider in interface IView

setIncludeInMenu

public void setIncludeInMenu(boolean includeInMenu)

Set the value of the includeInMenu property.

Contents: Flag to specify whether to include this view in the main menu.

Specified by:

setIncludeInMenu in interface IView

isIncludeInMenu

public boolean isIncludeInMenu()

Return the value of the includeInMenu property.

Contents: Flag to specify whether to include this view in the main menu. Default = 'true'.

Specified by:

isIncludeInMenu in interface IView

setMenuIcon

public void setMenuIcon(java.lang.String menuIcon)

Set the value of the menuIcon property.

Contents: The name of the icon to use for this view in the main menu. Possible values are Font Awesome icon names, without the prefix ('fa-'). These names can be found on this page http://fortawesome.github.io/Font-Awesome/icons/ .

Specified by:

setMenuIcon in interface IView

getMenuIcon

public java.lang.String getMenuIcon()

Return the value of the menuIcon property.

Contents: The name of the icon to use for this view in the main menu. Possible values are Font Awesome icon names, without the prefix ('fa-'). These names can be found on this page http://fortawesome.github.io/Font-Awesome/icons/ .

Specified by:

getMenuIcon in interface IView

setNavBarGroup

public void setNavBarGroup(java.lang.String navBarGroup)

Set the value of the navBarGroup property.

Contents: The nav bar group that this view will be rendered for.

Specified by:

setNavBarGroup in interface IView

getNavBarGroup

public java.lang.String getNavBarGroup()

Return the value of the navBarGroup property.

Contents: The nav bar group that this view will be rendered for.

Specified by:

getNavBarGroup in interface IView

setSplash

public void setSplash(boolean splash)

Set the value of the splash property.

Contents: Show this view as the splash screen.

Specified by:

setSplash in interface IView

isSplash

public boolean isSplash()

Return the value of the splash property.

Contents: Show this view as the splash screen.

Specified by:

isSplash in interface IView

setStyle

public void setStyle(java.lang.String style)

Set the value of the style property.

Contents: Sets the CSS style definition to be applied to this component.

Specified by:

setStyle in interface IView

getStyle

public java.lang.String getStyle()

Return the value of the style property.

Contents: Sets the CSS style definition to be applied to this component.

Specified by:

getStyle in interface IView

setStyleClass

public void setStyleClass(java.lang.String styleClass)

Set the value of the styleClass property.

Contents: Sets the CSS class to apply to this component.

Specified by:

setStyleClass in interface IView

getStyleClass

public java.lang.String getStyleClass()

Return the value of the styleClass property.

Contents: Sets the CSS class to apply to this component.

Specified by:

getStyleClass in interface IView

setTitle

public void setTitle(java.lang.String title)

Set the value of the title property.

Contents: The title of this view.

Specified by:

setTitle in interface IView

getTitle

public java.lang.String getTitle()

Return the value of the title property.

Contents: The title of this view. Default = '(no title)'.

Specified by:

getTitle in interface IView

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