com.liferay.faces.alloy.component.icon

Class IconBase

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

com.liferay.faces.alloy.component.icon.IconBase

All Implemented Interfaces:

com.liferay.faces.util.component.Styleable, 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

Direct Known Subclasses:

Icon

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

Author:

Bruno Basto, Kyle Stiemann

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	IconBase.IconPropertyKeys

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPONENT_FAMILY
static String	COMPONENT_TYPE
static 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

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

STYLE, STYLE_CLASS

Constructor Summary

Constructors

Constructor and Description
IconBase()

Method Summary

Methods

Modifier and Type	Method and Description
String	getColor() color attribute description: The color of the icon which this component will render.
String	getFamily()
String	getName() name attribute description: The icon which this component will render.
String	getStyle() style attribute description: HTML passthrough attribute specifying the css style of the element.
String	getStyleClass() styleClass attribute description: List of CSS class names (separated by spaces) that are to be rendered within the class attribute.
void	setColor(String color) color attribute description: The color of the icon which this component will render.
void	setName(String name) name attribute description: The icon which this component will render.
void	setStyle(String style) style attribute description: HTML passthrough attribute specifying the css style of the element.
void	setStyleClass(String styleClass) styleClass attribute description: List of CSS class names (separated by spaces) that are to be rendered within the class attribute.

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, setValueExpression, visitTree

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

See Also:

Constant Field Values

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

IconBase

public IconBase()

Method Detail

getFamily

public String getFamily()

Specified by:

getFamily in class javax.faces.component.UIComponent

getColor

public String getColor()

color attribute description:

The color of the icon which this component will render. Valid values include black (the default) and white.

setColor

public void setColor(String color)

color attribute description:

The color of the icon which this component will render. Valid values include black (the default) and white.

getName

public String getName()

name attribute description:

The icon which this component will render. A list of valid icons can be found at Bootstrap Base CSS. Note: icon names must be specified without the glyphicon glyphicon- prefix.

setName

public void setName(String name)

name attribute description:

The icon which this component will render. A list of valid icons can be found at Bootstrap Base CSS. Note: icon names must be specified without the glyphicon glyphicon- prefix.

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