org.apache.myfaces.tobago.component

Class UIStars

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UIOutput

javax.faces.component.UIInput

org.apache.myfaces.tobago.internal.component.AbstractUIInput

org.apache.myfaces.tobago.internal.component.AbstractUIStars

org.apache.myfaces.tobago.component.UIStars

All Implemented Interfaces:

EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.EditableValueHolder, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.component.ValueHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, SupportFieldId, SupportsAccessKey, SupportsAutoSpacing, SupportsHelp, SupportsLabelLayout, Visual

@Generated(value="component.stg")
public class UIStars
extends AbstractUIStars

Renders a star rating component. UIComponent class, generated from template component.stg with class StarsTagDeclaration.

Field Summary

Fields

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

Fields inherited from class javax.faces.component.UIInput

ALWAYS_PERFORM_VALIDATION_WHEN_REQUIRED_IS_TRUE, CONVERSION_MESSAGE_ID, EMPTY_STRING_AS_NULL_PARAM_NAME, REQUIRED_MESSAGE_ID, UPDATE_MESSAGE_ID, VALIDATE_EMPTY_FIELDS_PARAM_NAME

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
UIStars()

Method Summary

Modifier and Type	Method and Description
Character	getAccessKey() The access key of this control.
Boolean	getAutoSpacing() Automatically add spacing (margins/paddings) to the component for better positioning.
CustomClass	getCustomClass() Sets a CSS class in its parent, if the parent supports it.
String	getDefaultEventName()
Collection<String>	getEventNames()
String	getFamily()
String	getHelp() Text value to display as a help.
String	getLabel() A localized user presentable label for this component.
LabelLayout	getLabelLayout() Defines the position of the label relative to the field.
Markup	getMarkup()
Integer	getMax() The maximum value must be > '0'.
Double	getPlaceholder() The placeholder value is displayed if no star is set by the user.
Integer	getTabIndex() Controls the navigation of the focus through the input controls on a page with the Tab-Key.
String	getTip() Text value to display as tooltip.
boolean	isDisabled() Flag indicating that this element is disabled.
boolean	isFocus() Flag indicating this component should receive the focus.
boolean	isReadonly() Flag indicating that this component will prohibit changes by the user.
void	restoreState(javax.faces.context.FacesContext context, Object state)
void	setAccessKey(Character accessKey)
void	setAutoSpacing(Boolean autoSpacing)
void	setCustomClass(CustomClass customClass)
void	setDisabled(boolean disabled)
void	setFocus(boolean focus)
void	setHelp(String help)
void	setLabel(String label)
void	setLabelLayout(LabelLayout labelLayout)
void	setMarkup(Markup markup)
void	setMax(Integer max)
void	setPlaceholder(Double placeholder)
void	setReadonly(boolean readonly)
void	setTabIndex(Integer tabIndex)
void	setTip(String tip)

Methods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUIStars

getRangeMax, getRangeValue, processEvent

Methods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUIInput

getFieldId, isError, isNextToRenderIsLabel, setNextToRenderIsLabel

Methods inherited from class javax.faces.component.UIInput

addValidator, addValueChangeListener, broadcast, clearInitialState, compareValues, decode, getConvertedValue, getConverterMessage, getRequiredMessage, getSubmittedValue, getValidator, getValidatorMessage, getValidators, getValue, getValueChangeListener, getValueChangeListeners, isEmpty, isImmediate, isLocalValueSet, isRequired, isValid, markInitialState, processDecodes, processUpdates, processValidators, removeValidator, removeValueChangeListener, resetValue, saveState, setConverterMessage, setImmediate, setLocalValueSet, setRequired, setRequiredMessage, setSubmittedValue, setValid, setValidator, setValidatorMessage, setValue, setValueChangeListener, updateModel, validate, validateValue

Methods inherited from class javax.faces.component.UIOutput

getConverter, getLocalValue, setConverter

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, visitTree

Methods inherited from class javax.faces.component.UIComponent

getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.myfaces.tobago.component.SupportsAutoSpacing

getAutoSpacing

Methods inherited from interface org.apache.myfaces.tobago.component.Visual

getRendererType, isPlain

Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder

addClientBehavior, getClientBehaviors

Methods inherited from interface javax.faces.component.ValueHolder

getConverter, getLocalValue, setConverter

Field Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

See Also:

Constant Field Values

Constructor Detail

UIStars

public UIStars()

Method Detail

getEventNames

public Collection<String> getEventNames()

Specified by:

getEventNames in interface javax.faces.component.behavior.ClientBehaviorHolder

Overrides:

getEventNames in class javax.faces.component.UIComponentBase

getDefaultEventName

public String getDefaultEventName()

Specified by:

getDefaultEventName in interface javax.faces.component.behavior.ClientBehaviorHolder

Overrides:

getDefaultEventName in class javax.faces.component.UIComponentBase

getFamily

public String getFamily()

Overrides:

getFamily in class javax.faces.component.UIInput

getMarkup

public Markup getMarkup()

setMarkup

public void setMarkup(Markup markup)

getMax

public Integer getMax()

The maximum value must be > '0'. Default is '5'. To split stars, set a higher maximum value. E.g. set '10' for half stars, set '20' for quarter stars.

Specified by:

getMax in class AbstractUIStars

setMax

public void setMax(Integer max)

getLabelLayout

public LabelLayout getLabelLayout()

Defines the position of the label relative to the field. The default is flexLeft, if the label is set, or none, if the label isn't set. Set to 'skip' to avoid surrounding label container. Hint for tc:out: set also compact=true to render only text (without html tags).

setLabelLayout

public void setLabelLayout(LabelLayout labelLayout)

isFocus

public boolean isFocus()

Flag indicating this component should receive the focus.
Default: false

Specified by:

isFocus in class AbstractUIInput

setFocus

public void setFocus(boolean focus)

getTabIndex

public Integer getTabIndex()

Controls the navigation of the focus through the input controls on a page with the Tab-Key. The navigation starts from the element with the lowest tabIndex value to the element with the highest value. Elements that have identical tabIndex values should be navigated in the order they appear in the character stream Elements that are disabled or with a negative tabIndex do not participate in the tabbing order.

Specified by:

getTabIndex in class AbstractUIInput

setTabIndex

public void setTabIndex(Integer tabIndex)

getLabel

public String getLabel()

A localized user presentable label for this component.

setLabel

public void setLabel(String label)

getHelp

public String getHelp()

Text value to display as a help.

setHelp

public void setHelp(String help)

getAutoSpacing

public Boolean getAutoSpacing()

Automatically add spacing (margins/paddings) to the component for better positioning. Default is 'true' except the component is inside a: - header - footer - bar - sheet - tree - link group - button group - before facet - after facet - label facet - bar facet

setAutoSpacing

public void setAutoSpacing(Boolean autoSpacing)

isReadonly

public boolean isReadonly()

Flag indicating that this component will prohibit changes by the user.
Default: false

Specified by:

isReadonly in class AbstractUIInput

setReadonly

public void setReadonly(boolean readonly)

getAccessKey

public Character getAccessKey()

The access key of this control.

setAccessKey

public void setAccessKey(Character accessKey)

getCustomClass

public CustomClass getCustomClass()

Sets a CSS class in its parent, if the parent supports it. Which this feature it is possible to put a CSS class name into a component with the <tc:style> tag. Example:

   <tc:in>
     <tc:style customClass="my-emphasized"/>
   </tc:in>
   

One capability is, to used external CSS libs.
This feature should not be used imprudent. Because it might be unstable against changes in the renderered HTML code.

setCustomClass

public void setCustomClass(CustomClass customClass)

isDisabled

public boolean isDisabled()

Flag indicating that this element is disabled.
Default: false

Specified by:

isDisabled in class AbstractUIInput

setDisabled

public void setDisabled(boolean disabled)

getTip

public String getTip()

Text value to display as tooltip.

setTip

public void setTip(String tip)

getPlaceholder

public Double getPlaceholder()

The placeholder value is displayed if no star is set by the user. Value must be between '0' and '5'. The placeholder can show values which are not selectable by the user. E.g. if only full stars are available for the user, the placeholder can show a 4.6 star rating.

Specified by:

getPlaceholder in class AbstractUIStars

setPlaceholder

public void setPlaceholder(Double placeholder)

restoreState

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

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class javax.faces.component.UIInput