com.liferay.faces.portal.component.nav

Class NavBase

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UIData

com.liferay.faces.portal.component.nav.NavBase

All Implemented Interfaces:

com.liferay.faces.util.component.Styleable, EventListener, javax.faces.component.NamingContainer, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.component.UniqueIdVendor, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder

Direct Known Subclasses:

Nav

@Generated(value="com.liferay.alloy.tools.builder.FacesBuilder")
public abstract class NavBase
extends javax.faces.component.UIData
implements com.liferay.faces.util.component.Styleable

Author:

Neil Griffin

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	NavBase.NavPropertyKeys

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPONENT_TYPE
static String	RENDERER_TYPE

Fields inherited from class javax.faces.component.UIData

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

Fields inherited from interface com.liferay.faces.util.component.Styleable

STYLE, STYLE_CLASS

Fields inherited from interface javax.faces.component.NamingContainer

SEPARATOR_CHAR

Constructor Summary

Constructors

Constructor and Description
NavBase()

Method Summary

Modifier and Type	Method and Description
String	getAriaLabel() ariaLabel attribute description:
String	getAriaRole() ariaRole attribute description:
String	getStyle() style attribute description:
String	getStyleClass() styleClass attribute description:
boolean	isResponsive() responsive attribute description:
void	setAriaLabel(String ariaLabel) ariaLabel attribute description:
void	setAriaRole(String ariaRole) ariaRole attribute description:
void	setResponsive(boolean responsive) responsive attribute description:
void	setStyle(String style) style attribute description:
void	setStyleClass(String styleClass) styleClass attribute description:

Methods inherited from class javax.faces.component.UIData

broadcast, createUniqueId, encodeBegin, getClientId, getDataModel, getFamily, getFirst, getFooter, getHeader, getRowCount, getRowData, getRowIndex, getRows, getValue, getVar, invokeOnComponent, isRowAvailable, isRowStatePreserved, markInitialState, processDecodes, processUpdates, processValidators, queueEvent, restoreState, saveState, setDataModel, setFirst, setFooter, setHeader, setRowIndex, setRows, setRowStatePreserved, setValue, setValueBinding, setValueExpression, setVar, visitTree

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, clearInitialState, decode, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, 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

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 String COMPONENT_TYPE

See Also:

Constant Field Values

RENDERER_TYPE

public static final String RENDERER_TYPE

See Also:

Constant Field Values

Constructor Detail

NavBase

public NavBase()

Method Detail

getAriaLabel

public String getAriaLabel()

ariaLabel attribute description:

The WAI-ARIA label which can help users with disabilities when a text label is not visible.

setAriaLabel

public void setAriaLabel(String ariaLabel)

ariaLabel attribute description:

The WAI-ARIA label which can help users with disabilities when a text label is not visible.

getAriaRole

public String getAriaRole()

ariaRole attribute description:

The WAI-ARIA role which can help users with disabilities understand the purpose of an element, such as whether it is a menu, progress indicator, or some other type of component.

setAriaRole

public void setAriaRole(String ariaRole)

ariaRole attribute description:

The WAI-ARIA role which can help users with disabilities understand the purpose of an element, such as whether it is a menu, progress indicator, or some other type of component.

isResponsive

public boolean isResponsive()

responsive attribute description:

When true, the unordered list will be surrounded by <div class="collapse nav-collapse">...</div>. This is a responsive layout feature (that works in conjunction with an portal:navBar parent tag) for small/mobile displays that causes the child portal:navItem links to be displayed in a popup menu.

setResponsive

public void setResponsive(boolean responsive)

responsive attribute description:

When true, the unordered list will be surrounded by <div class="collapse nav-collapse">...</div>. This is a responsive layout feature (that works in conjunction with an portal:navBar parent tag) for small/mobile displays that causes the child portal:navItem links to be displayed in a popup menu.

getStyle

public String getStyle()

style attribute description:

HTML passthrough attribute specifying the css style of the element.

Specified by:

getStyle in interface com.liferay.faces.util.component.Styleable

setStyle

public void setStyle(String style)

style attribute description:

HTML passthrough attribute specifying the css style of the element.

Specified by:

setStyle in interface com.liferay.faces.util.component.Styleable

getStyleClass

public String getStyleClass()

styleClass attribute description:

List of CSS class names (separated by spaces) that are to be rendered within the class attribute.

Specified by:

getStyleClass in interface com.liferay.faces.util.component.Styleable

setStyleClass

public void setStyleClass(String styleClass)

styleClass attribute description:

List of CSS class names (separated by spaces) that are to be rendered within the class attribute.

Specified by:

setStyleClass in interface com.liferay.faces.util.component.Styleable