org.apache.myfaces.html5.component.output
Class SlideView

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by org.apache.myfaces.html5.component.output.AbstractSlideView
              extended by org.apache.myfaces.html5.component.output.SlideView
All Implemented Interfaces:
EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.NamingContainer, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, Draggable, AccesskeyProperty, TransitionProperties, GlobalEventProperties, Html5GlobalProperties, MouseEventProperties, PrependIdProperty, TabindexProperty, WidgetVarProperty

public class SlideView
extends AbstractSlideView
implements javax.faces.component.behavior.ClientBehaviorHolder


Field Summary
static String COMPONENT_FAMILY
           
static String COMPONENT_TYPE
           
 
Fields inherited from class org.apache.myfaces.html5.component.output.AbstractSlideView
DEFAULT_SLIDE_HEIGHT, DEFAULT_SLIDE_INACTIVE_SCALE, DEFAULT_SLIDE_LEFT, DEFAULT_SLIDE_WIDTH
 
Fields inherited from class javax.faces.component.UIComponent
BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEY
 
Fields inherited from interface javax.faces.component.NamingContainer
SEPARATOR_CHAR
 
Constructor Summary
SlideView()
           
 
Method Summary
 String getAccesskey()
          HTML: Sets the access key for this element.
 String getAnimationEnd()
          HTML : Script to run when the animation ends on Html element.
 String getDefaultEventName()
           
 String getDelay()
          Duration for animation/effect to wait before running.
 String getDir()
          HTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).
 String getDuration()
          Duration for animation/effect to run through.
 Collection<String> getEventNames()
           
 String getFamily()
           
 double getInactiveSlideScale()
          Scaling value of the inactive slides.
 String getLang()
          HTML: The base language of this document.
 String getOnblur()
          HTML: Specifies a script to be invoked when the element loses focus.
 String getOnclick()
          HTML: Script to be invoked when the element is clicked.
 String getOndblclick()
          HTML: Script to be invoked when the element is double-clicked.
 String getOndrag()
          HTML: Handler for event that is fired when the element is dragged.
 String getOndragend()
          HTML: Handler for event that is fired when the drag operation is ended.
 String getOndragenter()
          HTML: Handler for event that is fired when the element is dragged into a valid drop target.
 String getOndragleave()
          HTML: Handler for event that is fired when the element leaves a valid drop target.
 String getOndragover()
          HTML: Handler for event that is fired when the element is being dragged over a valid drop target.
 String getOndragstart()
          HTML: Handler for event that is fired when the drag operation starts.
 String getOndrop()
          HTML: Handler for event that is fired when the element is being dropped.
 String getOnfocus()
          HTML: Specifies a script to be invoked when the element receives focus.
 String getOnmousedown()
          HTML: Script to be invoked when the pointing device is pressed over this element.
 String getOnmousemove()
          HTML: Script to be invoked when the pointing device is moved while it is in this element.
 String getOnmouseout()
          HTML: Script to be invoked when the pointing device is moves out of this element.
 String getOnmouseover()
          HTML: Script to be invoked when the pointing device is moved into this element.
 String getOnmouseup()
          HTML: Script to be invoked when the pointing device is released over this element.
 String getOnmousewheel()
          HTML: Script to be invoked when the pointing device is wheeled over this element.
 double getSlideHeight()
          The percent value of the height of the active slide.
 double getSlideLeft()
          The percent value of the left position of the active slide.
 double getSlideWidth()
          The percent value of the width of the active slide.
 String getStyle()
          HTML: CSS styling instructions.
 String getStyleClass()
          The CSS class for this element.
 String getTabindex()
          HTML: Specifies the position of this element within the tab order of the document.
 String getTimingFunction()
          Timing function to calculate animation/effect transitions.
 String getTitle()
          HTML: An advisory title for this element.
 String getWidgetVar()
          Defines the Javascript variable name of the object created by this component.
Defaults to 'widget_' followed by the client id of the component where ':' characters in client id of the component are replaced with '_'.
 boolean isDraggable()
          HTML: Specifies whether the element is draggable.
 boolean isHidden()
          HTML: Whether the element is relevant.
 boolean isNavigateOnArrowKeys()
          If true, arrow keys will be registered to navigate between slides.
Defaults to true.
widgetVar can be used to navigate between slides manually.
 boolean isNavigateOnMouseWheel()
          If true, mouse wheel scroll will be registered to navigate between slides.
Defaults to true.
 boolean isPrependId()
          If true, descendent components will have an clientId with the id of the form prepended.
Defaults to true.
 void setAccesskey(String accesskey)
           
 void setAnimationEnd(String animationEnd)
           
 void setDelay(String delay)
           
 void setDir(String dir)
           
 void setDraggable(boolean draggable)
           
 void setDuration(String duration)
           
 void setHidden(boolean hidden)
           
 void setInactiveSlideScale(double inactiveSlideScale)
           
 void setLang(String lang)
           
 void setNavigateOnArrowKeys(boolean navigateOnArrowKeys)
           
 void setNavigateOnMouseWheel(boolean navigateOnMouseWheel)
           
 void setOnblur(String onblur)
           
 void setOnclick(String onclick)
           
 void setOndblclick(String ondblclick)
           
 void setOndrag(String ondrag)
           
 void setOndragend(String ondragend)
           
 void setOndragenter(String ondragenter)
           
 void setOndragleave(String ondragleave)
           
 void setOndragover(String ondragover)
           
 void setOndragstart(String ondragstart)
           
 void setOndrop(String ondrop)
           
 void setOnfocus(String onfocus)
           
 void setOnmousedown(String onmousedown)
           
 void setOnmousemove(String onmousemove)
           
 void setOnmouseout(String onmouseout)
           
 void setOnmouseover(String onmouseover)
           
 void setOnmouseup(String onmouseup)
           
 void setOnmousewheel(String onmousewheel)
           
 void setPrependId(boolean prependId)
           
 void setSlideHeight(double slideHeight)
           
 void setSlideLeft(double slideLeft)
           
 void setSlideWidth(double slideWidth)
           
 void setStyle(String style)
           
 void setStyleClass(String styleClass)
           
 void setTabindex(String tabindex)
           
 void setTimingFunction(String timingFunction)
           
 void setTitle(String title)
           
 void setWidgetVar(String widgetVar)
           
 
Methods inherited from class org.apache.myfaces.html5.component.output.AbstractSlideView
getContainerClientId
 
Methods inherited from class javax.faces.component.UIComponentBase
addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, initialStateMarked, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, visitTree
 
Methods inherited from class javax.faces.component.UIComponent
encodeAll, getClientId, getCompositeComponentParent, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getValueExpression, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, 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 javax.faces.component.behavior.ClientBehaviorHolder
addClientBehavior, getClientBehaviors
 

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
Constructor Detail

SlideView

public SlideView()
Method Detail

getFamily

public String getFamily()
Specified by:
getFamily in class javax.faces.component.UIComponent

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

getSlideLeft

public double getSlideLeft()
Description copied from class: AbstractSlideView
The percent value of the left position of the active slide. Defaults to 10.

Specified by:
getSlideLeft in class AbstractSlideView

setSlideLeft

public void setSlideLeft(double slideLeft)

getSlideWidth

public double getSlideWidth()
Description copied from class: AbstractSlideView
The percent value of the width of the active slide. Defaults to 80.

Specified by:
getSlideWidth in class AbstractSlideView

setSlideWidth

public void setSlideWidth(double slideWidth)

getSlideHeight

public double getSlideHeight()
Description copied from class: AbstractSlideView
The percent value of the height of the active slide. Defaults to 90.

Specified by:
getSlideHeight in class AbstractSlideView

setSlideHeight

public void setSlideHeight(double slideHeight)

getInactiveSlideScale

public double getInactiveSlideScale()
Description copied from class: AbstractSlideView
Scaling value of the inactive slides. Value should be in the interval [0.0, 1.0]. Defaults to 0.9.

Specified by:
getInactiveSlideScale in class AbstractSlideView

setInactiveSlideScale

public void setInactiveSlideScale(double inactiveSlideScale)

isNavigateOnArrowKeys

public boolean isNavigateOnArrowKeys()
Description copied from class: AbstractSlideView
If true, arrow keys will be registered to navigate between slides.
Defaults to true.
widgetVar can be used to navigate between slides manually.

Specified by:
isNavigateOnArrowKeys in class AbstractSlideView

setNavigateOnArrowKeys

public void setNavigateOnArrowKeys(boolean navigateOnArrowKeys)

isNavigateOnMouseWheel

public boolean isNavigateOnMouseWheel()
Description copied from class: AbstractSlideView
If true, mouse wheel scroll will be registered to navigate between slides.
Defaults to true. widgetVar can be used to navigate between slides manually.

Specified by:
isNavigateOnMouseWheel in class AbstractSlideView

setNavigateOnMouseWheel

public void setNavigateOnMouseWheel(boolean navigateOnMouseWheel)

getDuration

public String getDuration()
Description copied from interface: TransitionProperties
Duration for animation/effect to run through.
Value must be in seconds or milliseconds, thus must end with 's' or 'ms'. If not, the value is considered in seconds.
Some of the sample values are:

Specified by:
getDuration in interface TransitionProperties

setDuration

public void setDuration(String duration)

getTimingFunction

public String getTimingFunction()
Description copied from interface: TransitionProperties
Timing function to calculate animation/effect transitions.
The timing functions defined by CSS3 spec are:

Specified by:
getTimingFunction in interface TransitionProperties

setTimingFunction

public void setTimingFunction(String timingFunction)

getDelay

public String getDelay()
Description copied from interface: TransitionProperties
Duration for animation/effect to wait before running.
Value must be in seconds or milliseconds, thus must end with 's' or 'ms'. If not, the value is considered in seconds.
Some of the sample values are:

Specified by:
getDelay in interface TransitionProperties

setDelay

public void setDelay(String delay)

getAccesskey

public String getAccesskey()
Description copied from interface: AccesskeyProperty
HTML: Sets the access key for this element.

Specified by:
getAccesskey in interface AccesskeyProperty

setAccesskey

public void setAccesskey(String accesskey)

getOnclick

public String getOnclick()
Description copied from interface: MouseEventProperties
HTML: Script to be invoked when the element is clicked.

Specified by:
getOnclick in interface GlobalEventProperties
Specified by:
getOnclick in interface MouseEventProperties

setOnclick

public void setOnclick(String onclick)

getOndblclick

public String getOndblclick()
Description copied from interface: MouseEventProperties
HTML: Script to be invoked when the element is double-clicked.

Specified by:
getOndblclick in interface GlobalEventProperties
Specified by:
getOndblclick in interface MouseEventProperties

setOndblclick

public void setOndblclick(String ondblclick)

getOnblur

public String getOnblur()
Description copied from interface: GlobalEventProperties
HTML: Specifies a script to be invoked when the element loses focus.

Specified by:
getOnblur in interface GlobalEventProperties

setOnblur

public void setOnblur(String onblur)

getOnfocus

public String getOnfocus()
Description copied from interface: GlobalEventProperties
HTML: Specifies a script to be invoked when the element receives focus.

Specified by:
getOnfocus in interface GlobalEventProperties

setOnfocus

public void setOnfocus(String onfocus)

getOnmousedown

public String getOnmousedown()
Description copied from interface: MouseEventProperties
HTML: Script to be invoked when the pointing device is pressed over this element.

Specified by:
getOnmousedown in interface MouseEventProperties

setOnmousedown

public void setOnmousedown(String onmousedown)

getOnmousemove

public String getOnmousemove()
Description copied from interface: MouseEventProperties
HTML: Script to be invoked when the pointing device is moved while it is in this element.

Specified by:
getOnmousemove in interface MouseEventProperties

setOnmousemove

public void setOnmousemove(String onmousemove)

getOnmouseout

public String getOnmouseout()
Description copied from interface: MouseEventProperties
HTML: Script to be invoked when the pointing device is moves out of this element.

Specified by:
getOnmouseout in interface MouseEventProperties

setOnmouseout

public void setOnmouseout(String onmouseout)

getOnmouseover

public String getOnmouseover()
Description copied from interface: MouseEventProperties
HTML: Script to be invoked when the pointing device is moved into this element.

Specified by:
getOnmouseover in interface MouseEventProperties

setOnmouseover

public void setOnmouseover(String onmouseover)

getOnmouseup

public String getOnmouseup()
Description copied from interface: MouseEventProperties
HTML: Script to be invoked when the pointing device is released over this element.

Specified by:
getOnmouseup in interface MouseEventProperties

setOnmouseup

public void setOnmouseup(String onmouseup)

getOnmousewheel

public String getOnmousewheel()
Description copied from interface: Html5GlobalProperties
HTML: Script to be invoked when the pointing device is wheeled over this element.

Specified by:
getOnmousewheel in interface Html5GlobalProperties
Specified by:
getOnmousewheel in interface MouseEventProperties

setOnmousewheel

public void setOnmousewheel(String onmousewheel)

getDir

public String getDir()
Description copied from interface: Html5GlobalProperties
HTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).

Specified by:
getDir in interface Html5GlobalProperties

setDir

public void setDir(String dir)

getLang

public String getLang()
Description copied from interface: Html5GlobalProperties
HTML: The base language of this document.

Specified by:
getLang in interface Html5GlobalProperties

setLang

public void setLang(String lang)

getTitle

public String getTitle()
Description copied from interface: Html5GlobalProperties
HTML: An advisory title for this element. Often used by the user agent as a tooltip.

Specified by:
getTitle in interface Html5GlobalProperties

setTitle

public void setTitle(String title)

getStyle

public String getStyle()
Description copied from interface: Html5GlobalProperties
HTML: CSS styling instructions.

Specified by:
getStyle in interface Html5GlobalProperties

setStyle

public void setStyle(String style)

getStyleClass

public String getStyleClass()
Description copied from interface: Html5GlobalProperties
The CSS class for this element. Corresponds to the HTML 'class' attribute.

Specified by:
getStyleClass in interface Html5GlobalProperties

setStyleClass

public void setStyleClass(String styleClass)

isHidden

public boolean isHidden()
Description copied from interface: Html5GlobalProperties
HTML: Whether the element is relevant.

Specified by:
isHidden in interface Html5GlobalProperties

setHidden

public void setHidden(boolean hidden)

isDraggable

public boolean isDraggable()
Description copied from interface: Html5GlobalProperties
HTML: Specifies whether the element is draggable.

Specified by:
isDraggable in interface Html5GlobalProperties

setDraggable

public void setDraggable(boolean draggable)
Specified by:
setDraggable in interface Draggable

getOndrag

public String getOndrag()
Description copied from interface: Html5GlobalProperties
HTML: Handler for event that is fired when the element is dragged.

Specified by:
getOndrag in interface Html5GlobalProperties

setOndrag

public void setOndrag(String ondrag)

getOndragend

public String getOndragend()
Description copied from interface: Html5GlobalProperties
HTML: Handler for event that is fired when the drag operation is ended. Successfully or not, this handler will run.

Specified by:
getOndragend in interface Html5GlobalProperties

setOndragend

public void setOndragend(String ondragend)

getOndragenter

public String getOndragenter()
Description copied from interface: Html5GlobalProperties
HTML: Handler for event that is fired when the element is dragged into a valid drop target.

Specified by:
getOndragenter in interface Html5GlobalProperties

setOndragenter

public void setOndragenter(String ondragenter)

getOndragleave

public String getOndragleave()
Description copied from interface: Html5GlobalProperties
HTML: Handler for event that is fired when the element leaves a valid drop target.

Specified by:
getOndragleave in interface Html5GlobalProperties

setOndragleave

public void setOndragleave(String ondragleave)

getOndragover

public String getOndragover()
Description copied from interface: Html5GlobalProperties
HTML: Handler for event that is fired when the element is being dragged over a valid drop target.

Specified by:
getOndragover in interface Html5GlobalProperties

setOndragover

public void setOndragover(String ondragover)

getOndragstart

public String getOndragstart()
Description copied from interface: Html5GlobalProperties
HTML: Handler for event that is fired when the drag operation starts.

Specified by:
getOndragstart in interface Html5GlobalProperties

setOndragstart

public void setOndragstart(String ondragstart)

getOndrop

public String getOndrop()
Description copied from interface: Html5GlobalProperties
HTML: Handler for event that is fired when the element is being dropped.

Specified by:
getOndrop in interface Html5GlobalProperties

setOndrop

public void setOndrop(String ondrop)

getAnimationEnd

public String getAnimationEnd()
Description copied from interface: Html5GlobalProperties
HTML : Script to run when the animation ends on Html element.

Specified by:
getAnimationEnd in interface Html5GlobalProperties

setAnimationEnd

public void setAnimationEnd(String animationEnd)

getTabindex

public String getTabindex()
Description copied from interface: TabindexProperty
HTML: Specifies the position of this element within the tab order of the document.

Specified by:
getTabindex in interface TabindexProperty

setTabindex

public void setTabindex(String tabindex)

isPrependId

public boolean isPrependId()
Description copied from interface: PrependIdProperty
If true, descendent components will have an clientId with the id of the form prepended.
Defaults to true.

Specified by:
isPrependId in interface PrependIdProperty

setPrependId

public void setPrependId(boolean prependId)

getWidgetVar

public String getWidgetVar()
Description copied from interface: WidgetVarProperty
Defines the Javascript variable name of the object created by this component.
Defaults to 'widget_' followed by the client id of the component where ':' characters in client id of the component are replaced with '_'.

Specified by:
getWidgetVar in interface WidgetVarProperty

setWidgetVar

public void setWidgetVar(String widgetVar)


Copyright © 2011 The Apache Software Foundation. All Rights Reserved.