com.sun.j2ee.blueprints.ui.rating
Class RatingComponent

java.lang.Object
  extended byjavax.faces.component.UIComponent
      extended byjavax.faces.component.UIComponentBase
          extended bycom.sun.j2ee.blueprints.ui.rating.RatingComponent
All Implemented Interfaces:
javax.faces.component.StateHolder

public class RatingComponent
extends javax.faces.component.UIComponentBase

Component that displays the rating ("grade") for an item.


Field Summary
static int CLEAR_GRADE
          A "clear" grade.
static java.lang.String COMPONENT_FAMILY
          The standard component family for this component.
static int NOT_INTERESTED_GRADE
          A "not interested" grade.
static java.lang.String RENDERER_TYPE
          The standard renderer type for this component.
 
Constructor Summary
RatingComponent()
           
 
Method Summary
 double getAverageGrade()
           
 java.lang.String getAverageModeAcknowledgedText()
           
 java.lang.String getAverageModeHoverText()
           
 java.lang.String getAverageModeText()
           
 java.lang.String getClearHoverText()
           
 java.lang.String getFamily()
          Return the component family for this component.
 int getGrade()
           
 java.lang.String getGradeAcknowledgedText()
           
 java.lang.String[] getHoverTexts()
           
 int getMaxGrade()
           
 java.lang.String getNormalModeAcknowledgedText()
           
 java.lang.String getNormalModeHoverText()
           
 java.lang.String getNormalModeText()
           
 java.lang.String getNotInterestedHoverText()
           
 java.lang.String getOnGrade()
           
 java.lang.String getOnModeToggle()
           
 java.lang.String getOnMouse()
           
 java.lang.String getStyle()
          CSS style(s) to be applied when this component is rendered.
 java.lang.String getStyleClass()
          CSS style class(es) to be applied when this component is rendered.
 javax.faces.el.ValueBinding getValueBinding(java.lang.String name)
          Return the ValueBinding stored for the specified name (if any), respecting any property aliases.
 boolean isGradeReadOnly()
           
 boolean isInAverageMode()
           
 boolean isIncludeClear()
           
 boolean isIncludeModeToggle()
           
 boolean isIncludeNotInterested()
           
 boolean isIncludeText()
           
 boolean isModeReadOnly()
           
 void restoreState(javax.faces.context.FacesContext context, java.lang.Object state)
           
 java.lang.Object saveState(javax.faces.context.FacesContext context)
          Return the state to be saved for this component.
 void setAverageGrade(double averageGrade)
           
 void setAverageModeAcknowledgedText(java.lang.String averageModeAcknowledgedText)
           
 void setAverageModeHoverText(java.lang.String averageModeHoverText)
           
 void setAverageModeText(java.lang.String averageModeText)
           
 void setClearHoverText(java.lang.String clearHoverText)
           
 void setGrade(int grade)
           
 void setGradeAcknowledgedText(java.lang.String gradeAcknowledgedText)
           
 void setGradeReadOnly(boolean gradeReadOnly)
           
 void setHoverTexts(java.lang.String[] hoverTexts)
           
 void setInAverageMode(boolean inAverageMode)
           
 void setIncludeClear(boolean includeClear)
           
 void setIncludeModeToggle(boolean includeModeToggle)
           
 void setIncludeNotInterested(boolean includeNotInterested)
           
 void setIncludeText(boolean includeText)
           
 void setMaxGrade(int maxGrade)
           
 void setModeReadOnly(boolean modeReadOnly)
           
 void setNormalModeAcknowledgedText(java.lang.String normalModeAcknowledgedText)
           
 void setNormalModeHoverText(java.lang.String normalModeHoverText)
           
 void setNormalModeText(java.lang.String normalModeText)
           
 void setNotInterestedHoverText(java.lang.String notInterestedHoverText)
           
 void setOnGrade(java.lang.String onGrade)
           
 void setOnModeToggle(java.lang.String onModeToggle)
           
 void setOnMouse(java.lang.String onMouse)
           
 void setStyle(java.lang.String style)
          CSS style(s) to be applied when this component is rendered.
 void setStyleClass(java.lang.String styleClass)
          CSS style class(es) to be applied when this component is rendered.
 void setValueBinding(java.lang.String name, javax.faces.el.ValueBinding binding)
          Set the ValueBinding stored for the specified name (if any), respecting any property aliases.
 
Methods inherited from class javax.faces.component.UIComponentBase
addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient
 
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 java.lang.String COMPONENT_FAMILY

The standard component family for this component.

See Also:
Constant Field Values

RENDERER_TYPE

public static final java.lang.String RENDERER_TYPE

The standard renderer type for this component.

See Also:
Constant Field Values

NOT_INTERESTED_GRADE

public static final int NOT_INTERESTED_GRADE

A "not interested" grade.

See Also:
Constant Field Values

CLEAR_GRADE

public static final int CLEAR_GRADE

A "clear" grade.

See Also:
Constant Field Values
Constructor Detail

RatingComponent

public RatingComponent()
Method Detail

getFamily

public java.lang.String getFamily()

Return the component family for this component.


getValueBinding

public javax.faces.el.ValueBinding getValueBinding(java.lang.String name)

Return the ValueBinding stored for the specified name (if any), respecting any property aliases.

Parameters:
name - Name of value binding to retrieve

setValueBinding

public void setValueBinding(java.lang.String name,
                            javax.faces.el.ValueBinding binding)

Set the ValueBinding stored for the specified name (if any), respecting any property aliases.

Parameters:
name - Name of value binding to set
binding - ValueBinding to set, or null to remove

getMaxGrade

public int getMaxGrade()

setMaxGrade

public void setMaxGrade(int maxGrade)

getGrade

public int getGrade()

setGrade

public void setGrade(int grade)

getAverageGrade

public double getAverageGrade()

setAverageGrade

public void setAverageGrade(double averageGrade)

isInAverageMode

public boolean isInAverageMode()

setInAverageMode

public void setInAverageMode(boolean inAverageMode)

isIncludeNotInterested

public boolean isIncludeNotInterested()

setIncludeNotInterested

public void setIncludeNotInterested(boolean includeNotInterested)

isIncludeClear

public boolean isIncludeClear()

setIncludeClear

public void setIncludeClear(boolean includeClear)

isIncludeModeToggle

public boolean isIncludeModeToggle()

setIncludeModeToggle

public void setIncludeModeToggle(boolean includeModeToggle)

isIncludeText

public boolean isIncludeText()

setIncludeText

public void setIncludeText(boolean includeText)

getHoverTexts

public java.lang.String[] getHoverTexts()

setHoverTexts

public void setHoverTexts(java.lang.String[] hoverTexts)

getNotInterestedHoverText

public java.lang.String getNotInterestedHoverText()

setNotInterestedHoverText

public void setNotInterestedHoverText(java.lang.String notInterestedHoverText)

getClearHoverText

public java.lang.String getClearHoverText()

setClearHoverText

public void setClearHoverText(java.lang.String clearHoverText)

getNormalModeHoverText

public java.lang.String getNormalModeHoverText()

setNormalModeHoverText

public void setNormalModeHoverText(java.lang.String normalModeHoverText)

getAverageModeHoverText

public java.lang.String getAverageModeHoverText()

setAverageModeHoverText

public void setAverageModeHoverText(java.lang.String averageModeHoverText)

getGradeAcknowledgedText

public java.lang.String getGradeAcknowledgedText()

setGradeAcknowledgedText

public void setGradeAcknowledgedText(java.lang.String gradeAcknowledgedText)

getNormalModeAcknowledgedText

public java.lang.String getNormalModeAcknowledgedText()

setNormalModeAcknowledgedText

public void setNormalModeAcknowledgedText(java.lang.String normalModeAcknowledgedText)

getAverageModeAcknowledgedText

public java.lang.String getAverageModeAcknowledgedText()

setAverageModeAcknowledgedText

public void setAverageModeAcknowledgedText(java.lang.String averageModeAcknowledgedText)

getNormalModeText

public java.lang.String getNormalModeText()

setNormalModeText

public void setNormalModeText(java.lang.String normalModeText)

getAverageModeText

public java.lang.String getAverageModeText()

setAverageModeText

public void setAverageModeText(java.lang.String averageModeText)

isGradeReadOnly

public boolean isGradeReadOnly()

setGradeReadOnly

public void setGradeReadOnly(boolean gradeReadOnly)

isModeReadOnly

public boolean isModeReadOnly()

setModeReadOnly

public void setModeReadOnly(boolean modeReadOnly)

getOnGrade

public java.lang.String getOnGrade()

setOnGrade

public void setOnGrade(java.lang.String onGrade)

getOnModeToggle

public java.lang.String getOnModeToggle()

setOnModeToggle

public void setOnModeToggle(java.lang.String onModeToggle)

getOnMouse

public java.lang.String getOnMouse()

setOnMouse

public void setOnMouse(java.lang.String onMouse)

getStyle

public java.lang.String getStyle()

CSS style(s) to be applied when this component is rendered.


setStyle

public void setStyle(java.lang.String style)

CSS style(s) to be applied when this component is rendered.

See Also:
getStyle()

getStyleClass

public java.lang.String getStyleClass()

CSS style class(es) to be applied when this component is rendered.


setStyleClass

public void setStyleClass(java.lang.String styleClass)

CSS style class(es) to be applied when this component is rendered.

See Also:
getStyleClass()

saveState

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

Return the state to be saved for this component.

Parameters:
context - FacesContext for the current request

restoreState

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