|
ICEfaces ACE Components 3.3.0 Java API Documentation |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.faces.component.UIComponent
javax.faces.component.UIComponentBase
org.icefaces.ace.component.dnd.DroppableBase
public class DroppableBase
Allows a specified component to act as an area where Draggable items can be moved onto and register the event.
For more information, see the Droppable Wiki Documentation.
Nested Class Summary | |
---|---|
protected static class |
DroppableBase.PropertyKeys
|
Field Summary | |
---|---|
static java.lang.String |
COMPONENT_TYPE
|
static java.lang.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 |
Constructor Summary | |
---|---|
DroppableBase()
|
Method Summary | |
---|---|
void |
addClientBehavior(java.lang.String eventName,
javax.faces.component.behavior.ClientBehavior behavior)
|
java.lang.String |
getAccept()
Return the value of the accept property. |
java.lang.String |
getActiveStyleClass()
Return the value of the activeStyleClass property. |
java.lang.String |
getDatasource()
Return the value of the datasource property. |
java.lang.String |
getDefaultEventName()
|
java.lang.String |
getDefaultExecute(java.lang.String event)
|
java.lang.String |
getDefaultRender(java.lang.String event)
|
javax.el.MethodExpression |
getDropListener()
Return the value of the dropListener property. |
java.util.Collection<java.lang.String> |
getEventNames()
|
java.lang.String |
getFamily()
|
java.lang.String |
getFor()
Return the value of the for property. |
java.lang.String |
getHoverStyleClass()
Return the value of the hoverStyleClass property. |
java.lang.String |
getScope()
Return the value of the scope property. |
java.lang.String |
getTolerance()
Return the value of the tolerance property. |
java.lang.String |
getWidgetVar()
Return the value of the widgetVar property. |
boolean |
isDisabled()
Return the value of the disabled property. |
void |
setAccept(java.lang.String accept)
Set the value of the accept property. |
void |
setActiveStyleClass(java.lang.String activeStyleClass)
Set the value of the activeStyleClass property. |
void |
setDatasource(java.lang.String datasource)
Set the value of the datasource property. |
void |
setDisabled(boolean disabled)
Set the value of the disabled property. |
void |
setDropListener(javax.el.MethodExpression dropListener)
Set the value of the dropListener property. |
void |
setFor(java.lang.String forValue)
Set the value of the for property. |
void |
setHoverStyleClass(java.lang.String hoverStyleClass)
Set the value of the hoverStyleClass property. |
void |
setScope(java.lang.String scope)
Set the value of the scope property. |
void |
setTolerance(java.lang.String tolerance)
Set the value of the tolerance property. |
void |
setWidgetVar(java.lang.String widgetVar)
Set the value of the widgetVar property. |
Methods inherited from class javax.faces.component.UIComponentBase |
---|
addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, 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, 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 |
Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder |
---|
getClientBehaviors |
Field Detail |
---|
public static final java.lang.String COMPONENT_TYPE
public static final java.lang.String RENDERER_TYPE
Constructor Detail |
---|
public DroppableBase()
Method Detail |
---|
public java.lang.String getFamily()
getFamily
in class javax.faces.component.UIComponent
public void setAccept(java.lang.String accept)
Set the value of the accept
property.
Contents: JQuery selector to define the set of acceptable draggables.
setAccept
in interface IDroppable
public java.lang.String getAccept()
Return the value of the accept
property.
Contents: JQuery selector to define the set of acceptable draggables.
getAccept
in interface IDroppable
public void setActiveStyleClass(java.lang.String activeStyleClass)
Set the value of the activeStyleClass
property.
Contents: Class to apply to the droppable component when an acceptable draggable is dropped.
setActiveStyleClass
in interface IDroppable
public java.lang.String getActiveStyleClass()
Return the value of the activeStyleClass
property.
Contents: Class to apply to the droppable component when an acceptable draggable is dropped.
getActiveStyleClass
in interface IDroppable
public void setDatasource(java.lang.String datasource)
Set the value of the datasource
property.
Contents: Allows you to set the ID of an ACE UIData component and that will provide a Java object as input for the drop event. That object is defined by matching the sibling index of the droppable to an object at that index in the UIData component backing.
setDatasource
in interface IDroppable
public java.lang.String getDatasource()
Return the value of the datasource
property.
Contents: Allows you to set the ID of an ACE UIData component and that will provide a Java object as input for the drop event. That object is defined by matching the sibling index of the droppable to an object at that index in the UIData component backing.
getDatasource
in interface IDroppable
public void setDisabled(boolean disabled)
Set the value of the disabled
property.
Contents: If enabled, no draggables will activate this droppable.
setDisabled
in interface IDroppable
public boolean isDisabled()
Return the value of the disabled
property.
Contents: If enabled, no draggables will activate this droppable.
isDisabled
in interface IDroppable
public void setDropListener(javax.el.MethodExpression dropListener)
Set the value of the dropListener
property.
Contents: MethodExpression reference to a method called whenever a draggable is moved into this droppable. The method receives a single argument, DragDropEvent.
setDropListener
in interface IDroppable
public javax.el.MethodExpression getDropListener()
Return the value of the dropListener
property.
Contents: MethodExpression reference to a method called whenever a draggable is moved into this droppable. The method receives a single argument, DragDropEvent.
getDropListener
in interface IDroppable
public void setFor(java.lang.String forValue)
Set the value of the for
property.
Contents: Id of the component to add the droppable behavior to.
setFor
in interface IDroppable
public java.lang.String getFor()
Return the value of the for
property.
Contents: Id of the component to add the droppable behavior to.
getFor
in interface IDroppable
public void setHoverStyleClass(java.lang.String hoverStyleClass)
Set the value of the hoverStyleClass
property.
Contents: Class to apply to the droppable component when an acceptable draggable is hovering.
setHoverStyleClass
in interface IDroppable
public java.lang.String getHoverStyleClass()
Return the value of the hoverStyleClass
property.
Contents: Class to apply to the droppable component when an acceptable draggable is hovering.
getHoverStyleClass
in interface IDroppable
public void setScope(java.lang.String scope)
Set the value of the scope
property.
Contents: This keyword allows sets of dragabbles and droppables with the same keyword to be associated with each other exclusively.
setScope
in interface IDroppable
public java.lang.String getScope()
Return the value of the scope
property.
Contents: This keyword allows sets of dragabbles and droppables with the same keyword to be associated with each other exclusively.
getScope
in interface IDroppable
public void setTolerance(java.lang.String tolerance)
Set the value of the tolerance
property.
Contents: This arbitrary keyword specifies the method of checking if a draggable is 'over' the droppable, possible values include: fit (drag must be smaller), intersect (drag must cover > 50%). pointer (cursor must be inside drop) and touch (any of the drop touches).
setTolerance
in interface IDroppable
public java.lang.String getTolerance()
Return the value of the tolerance
property.
Contents: This arbitrary keyword specifies the method of checking if a draggable is 'over' the droppable, possible values include: fit (drag must be smaller), intersect (drag must cover > 50%). pointer (cursor must be inside drop) and touch (any of the drop touches).
getTolerance
in interface IDroppable
public void setWidgetVar(java.lang.String widgetVar)
Set the value of the widgetVar
property.
Contents: The JavaScript component instance variable name.
setWidgetVar
in interface IDroppable
public java.lang.String getWidgetVar()
Return the value of the widgetVar
property.
Contents: The JavaScript component instance variable name.
getWidgetVar
in interface IDroppable
public java.util.Collection<java.lang.String> getEventNames()
getEventNames
in interface javax.faces.component.behavior.ClientBehaviorHolder
getEventNames
in class javax.faces.component.UIComponentBase
public java.lang.String getDefaultEventName()
getDefaultEventName
in interface javax.faces.component.behavior.ClientBehaviorHolder
getDefaultEventName
in class javax.faces.component.UIComponentBase
public java.lang.String getDefaultRender(java.lang.String event)
getDefaultRender
in interface IceClientBehaviorHolder
public java.lang.String getDefaultExecute(java.lang.String event)
getDefaultExecute
in interface IceClientBehaviorHolder
public void addClientBehavior(java.lang.String eventName, javax.faces.component.behavior.ClientBehavior behavior)
addClientBehavior
in interface javax.faces.component.behavior.ClientBehaviorHolder
addClientBehavior
in class javax.faces.component.UIComponentBase
|
ICEfaces ACE Components 3.3.0 Java API Documentation |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |