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

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          org.apache.myfaces.html5.component.output.AbstractSlideView

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

Direct Known Subclasses:

SlideView

@JSFComponent(name="hx:slideView",
              clazz="org.apache.myfaces.html5.component.output.SlideView",
              tagClass="org.apache.myfaces.html5.tag.output.SlideViewTag",
              defaultRendererType="org.apache.myfaces.html5.SlideView",
              family="org.apache.myfaces.SlideView",
              type="org.apache.myfaces.html5.SlideView",
              implementz="javax.faces.component.behavior.ClientBehaviorHolder",
              defaultEventName="click")
public abstract class AbstractSlideView
extends javax.faces.component.UIComponentBase
implements javax.faces.component.behavior.ClientBehaviorHolder, Html5GlobalProperties, AccesskeyProperty, TabindexProperty, MouseEventProperties, GlobalEventProperties, WidgetVarProperty, TransitionProperties, PrependIdProperty, javax.faces.component.NamingContainer

Provides a presentation-like slide view.
Page authors should nest hx:slide components inside.

Author:

Ali Ok

Field Summary

static Double	DEFAULT_SLIDE_HEIGHT
static Double	DEFAULT_SLIDE_INACTIVE_SCALE
static Double	DEFAULT_SLIDE_LEFT
static Double	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

AbstractSlideView()

Method Summary

String	getContainerClientId(javax.faces.context.FacesContext ctx)
abstract double	getInactiveSlideScale() Scaling value of the inactive slides.
abstract double	getSlideHeight() The percent value of the height of the active slide.
abstract double	getSlideLeft() The percent value of the left position of the active slide.
abstract double	getSlideWidth() The percent value of the width of the active slide.
abstract 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.
abstract boolean	isNavigateOnMouseWheel() If true, mouse wheel scroll will be registered to navigate between slides. Defaults to true.

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, 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, getFamily, 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, getDefaultEventName, getEventNames

Methods inherited from interface org.apache.myfaces.html5.component.properties.Html5GlobalProperties

getAnimationEnd, getDir, getLang, getOndrag, getOndragend, getOndragenter, getOndragleave, getOndragover, getOndragstart, getOndrop, getOnmousewheel, getStyle, getStyleClass, getTitle, isDraggable, isHidden

Methods inherited from interface org.apache.myfaces.html5.component.api.Draggable

setDraggable

Methods inherited from interface org.apache.myfaces.html5.component.properties.AccesskeyProperty

getAccesskey

Methods inherited from interface org.apache.myfaces.html5.component.properties.TabindexProperty

getTabindex

Methods inherited from interface org.apache.myfaces.html5.component.properties.MouseEventProperties

getOnclick, getOndblclick, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getOnmousewheel

Methods inherited from interface org.apache.myfaces.html5.component.properties.GlobalEventProperties

getOnblur, getOnclick, getOndblclick, getOnfocus

Methods inherited from interface org.apache.myfaces.html5.component.properties.WidgetVarProperty

getWidgetVar

Methods inherited from interface org.apache.myfaces.html5.component.properties.effect.TransitionProperties

getDelay, getDuration, getTimingFunction

Methods inherited from interface org.apache.myfaces.html5.component.properties.PrependIdProperty

isPrependId

Field Detail

DEFAULT_SLIDE_LEFT

public static final Double DEFAULT_SLIDE_LEFT

DEFAULT_SLIDE_WIDTH

public static final Double DEFAULT_SLIDE_WIDTH

DEFAULT_SLIDE_HEIGHT

public static final Double DEFAULT_SLIDE_HEIGHT

DEFAULT_SLIDE_INACTIVE_SCALE

public static final Double DEFAULT_SLIDE_INACTIVE_SCALE

Constructor Detail

AbstractSlideView

public AbstractSlideView()

Method Detail

getSlideLeft

@JSFProperty(required=false,
             deferredValueType="java.lang.Double",
             defaultValue="DEFAULT_SLIDE_LEFT")
public abstract double getSlideLeft()

The percent value of the left position of the active slide. Defaults to 10.

getSlideWidth

@JSFProperty(required=false,
             deferredValueType="java.lang.Double",
             defaultValue="DEFAULT_SLIDE_WIDTH")
public abstract double getSlideWidth()

The percent value of the width of the active slide. Defaults to 80.

getSlideHeight

@JSFProperty(required=false,
             deferredValueType="java.lang.Double",
             defaultValue="DEFAULT_SLIDE_HEIGHT")
public abstract double getSlideHeight()

The percent value of the height of the active slide. Defaults to 90.

getInactiveSlideScale

@JSFProperty(required=false,
             deferredValueType="java.lang.Double",
             defaultValue="DEFAULT_SLIDE_INACTIVE_SCALE")
public abstract double getInactiveSlideScale()

Scaling value of the inactive slides. Value should be in the interval [0.0, 1.0]. Defaults to 0.9.

isNavigateOnArrowKeys

@JSFProperty(required=false,
             deferredValueType="java.lang.Boolean",
             defaultValue="true")
public abstract 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.

isNavigateOnMouseWheel

@JSFProperty(required=false,
             deferredValueType="java.lang.Boolean",
             defaultValue="true")
public abstract boolean isNavigateOnMouseWheel()

If true, mouse wheel scroll will be registered to navigate between slides.
Defaults to true. widgetVar can be used to navigate between slides manually.

getContainerClientId

public String getContainerClientId(javax.faces.context.FacesContext ctx)

Overrides:

getContainerClientId in class javax.faces.component.UIComponent