|
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.listcontrol.ListControlBase
public class ListControlBase
Renders a set of controls for moving items among ace:list components. Requires a selector that defines the set of ace:list components to move items between. Defaults to all lists. Optionally if this component has two nested ace:list children, they will be rendered within a styled container, and connected via this control without configuration.
For more information, see the List Control Wiki Documentation.
Nested Class Summary | |
---|---|
protected static class |
ListControlBase.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 | |
---|---|
ListControlBase()
|
Method Summary | |
---|---|
java.lang.String |
getAllLeftClass()
Return the value of the allLeftClass property. |
java.lang.String |
getAllRightClass()
Return the value of the allRightClass property. |
java.lang.String |
getControlClass()
Return the value of the controlClass property. |
java.lang.String |
getFamily()
|
java.lang.String |
getFooterClass()
Return the value of the footerClass property. |
java.lang.String |
getFooterStyle()
Return the value of the footerStyle property. |
java.lang.String |
getFormat()
Return the value of the format property. |
java.lang.String |
getHeaderClass()
Return the value of the headerClass property. |
java.lang.String |
getHeaderStyle()
Return the value of the headerStyle property. |
java.lang.String |
getLeftClass()
Return the value of the leftClass property. |
DualListPosition |
getPosition()
Return the value of the position property. |
java.lang.Object |
getRenderContext()
Return the value of the renderContext property. |
java.lang.String |
getRightClass()
Return the value of the rightClass property. |
java.lang.String |
getSelector()
Return the value of the selector property. |
java.lang.String |
getSpacerClass()
Return the value of the spacerClass property. |
java.lang.String |
getStyle()
Return the value of the style property. |
java.lang.String |
getStyleClass()
Return the value of the styleClass property. |
void |
setAllLeftClass(java.lang.String allLeftClass)
Set the value of the allLeftClass property. |
void |
setAllRightClass(java.lang.String allRightClass)
Set the value of the allRightClass property. |
void |
setControlClass(java.lang.String controlClass)
Set the value of the controlClass property. |
void |
setFooterClass(java.lang.String footerClass)
Set the value of the footerClass property. |
void |
setFooterStyle(java.lang.String footerStyle)
Set the value of the footerStyle property. |
void |
setFormat(java.lang.String format)
Set the value of the format property. |
void |
setHeaderClass(java.lang.String headerClass)
Set the value of the headerClass property. |
void |
setHeaderStyle(java.lang.String headerStyle)
Set the value of the headerStyle property. |
void |
setLeftClass(java.lang.String leftClass)
Set the value of the leftClass property. |
void |
setPosition(DualListPosition position)
Set the value of the position property. |
void |
setRenderContext(java.lang.Object renderContext)
Set the value of the renderContext property. |
void |
setRightClass(java.lang.String rightClass)
Set the value of the rightClass property. |
void |
setSelector(java.lang.String selector)
Set the value of the selector property. |
void |
setSpacerClass(java.lang.String spacerClass)
Set the value of the spacerClass property. |
void |
setStyle(java.lang.String style)
Set the value of the style property. |
void |
setStyleClass(java.lang.String styleClass)
Set the value of the styleClass property. |
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, 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 |
Field Detail |
---|
public static final java.lang.String COMPONENT_TYPE
public static final java.lang.String RENDERER_TYPE
Constructor Detail |
---|
public ListControlBase()
Method Detail |
---|
public java.lang.String getFamily()
getFamily
in class javax.faces.component.UIComponent
public void setAllLeftClass(java.lang.String allLeftClass)
Set the value of the allLeftClass
property.
Contents: Style class to apply to the all-left button icon element.
setAllLeftClass
in interface IListControl
public java.lang.String getAllLeftClass()
Return the value of the allLeftClass
property.
Contents: Style class to apply to the all-left button icon element. Default = 'ui-icon ui-icon-arrowstop-1-w'.
getAllLeftClass
in interface IListControl
public void setAllRightClass(java.lang.String allRightClass)
Set the value of the allRightClass
property.
Contents: Style class to apply to the all-right button icon element.
setAllRightClass
in interface IListControl
public java.lang.String getAllRightClass()
Return the value of the allRightClass
property.
Contents: Style class to apply to the all-right button icon element. Default = 'ui-icon ui-icon-arrowstop-1-e'.
getAllRightClass
in interface IListControl
public void setControlClass(java.lang.String controlClass)
Set the value of the controlClass
property.
Contents: Style class to apply to the container around each button icon element.
setControlClass
in interface IListControl
public java.lang.String getControlClass()
Return the value of the controlClass
property.
Contents: Style class to apply to the container around each button icon element. Default = 'ui-state-default ui-corner-all'.
getControlClass
in interface IListControl
public void setFooterClass(java.lang.String footerClass)
Set the value of the footerClass
property.
Contents: Style class to apply to the footer DIV element.
setFooterClass
in interface IListControl
public java.lang.String getFooterClass()
Return the value of the footerClass
property.
Contents: Style class to apply to the footer DIV element. Default = 'ui-widget-content'.
getFooterClass
in interface IListControl
public void setFooterStyle(java.lang.String footerStyle)
Set the value of the footerStyle
property.
Contents: Style rules to apply to the footer DIV element.
setFooterStyle
in interface IListControl
public java.lang.String getFooterStyle()
Return the value of the footerStyle
property.
Contents: Style rules to apply to the footer DIV element.
getFooterStyle
in interface IListControl
public void setFormat(java.lang.String format)
Set the value of the format
property.
Contents: Defines the order that the movement controls appear in.
setFormat
in interface IListControl
public java.lang.String getFormat()
Return the value of the format
property.
Contents: Defines the order that the movement controls appear in. Default = 'alll lft rgt allr'.
getFormat
in interface IListControl
public void setHeaderClass(java.lang.String headerClass)
Set the value of the headerClass
property.
Contents: Style class to apply to the header DIV element.
setHeaderClass
in interface IListControl
public java.lang.String getHeaderClass()
Return the value of the headerClass
property.
Contents: Style class to apply to the header DIV element. Default = 'ui-state-default'.
getHeaderClass
in interface IListControl
public void setHeaderStyle(java.lang.String headerStyle)
Set the value of the headerStyle
property.
Contents: Style rules to apply to the header DIV element.
setHeaderStyle
in interface IListControl
public java.lang.String getHeaderStyle()
Return the value of the headerStyle
property.
Contents: Style rules to apply to the header DIV element.
getHeaderStyle
in interface IListControl
public void setLeftClass(java.lang.String leftClass)
Set the value of the leftClass
property.
Contents: Style class to apply to the left button icon element.
setLeftClass
in interface IListControl
public java.lang.String getLeftClass()
Return the value of the leftClass
property.
Contents: Style class to apply to the left button icon element. Default = 'ui-icon ui-icon-arrow-1-w'.
getLeftClass
in interface IListControl
public void setPosition(DualListPosition position)
Set the value of the position
property.
Contents: When dual list mode is used, this property will determine if we render the migration control in the "MIDDLE", on the "TOP", "BOTTOM" or "BOTH" ends of the nested lists. "ALL" renders controls in every position
setPosition
in interface IListControl
public DualListPosition getPosition()
Return the value of the position
property.
Contents: When dual list mode is used, this property will determine if we render the migration control in the "MIDDLE", on the "TOP", "BOTTOM" or "BOTH" ends of the nested lists. "ALL" renders controls in every position Default = 'DualListPosition.TOP'.
getPosition
in interface IListControl
public void setRightClass(java.lang.String rightClass)
Set the value of the rightClass
property.
Contents: Style class to apply to the right button icon element.
setRightClass
in interface IListControl
public java.lang.String getRightClass()
Return the value of the rightClass
property.
Contents: Style class to apply to the right button icon element. Default = 'ui-icon ui-icon-arrow-1-e'.
getRightClass
in interface IListControl
public void setSelector(java.lang.String selector)
Set the value of the selector
property.
Contents: JQuery/CSS selector defining the group of lists this control navigates and creates mutually exclusive selection between. Default selects all lists. When in dual list mode, this property has no effect.
setSelector
in interface IListControl
public java.lang.String getSelector()
Return the value of the selector
property.
Contents: JQuery/CSS selector defining the group of lists this control navigates and creates mutually exclusive selection between. Default selects all lists. When in dual list mode, this property has no effect. Default = '.if-list'.
getSelector
in interface IListControl
public void setSpacerClass(java.lang.String spacerClass)
Set the value of the spacerClass
property.
Contents: Style class to apply to the spacer container around each button element.
setSpacerClass
in interface IListControl
public java.lang.String getSpacerClass()
Return the value of the spacerClass
property.
Contents: Style class to apply to the spacer container around each button element.
getSpacerClass
in interface IListControl
public void setStyle(java.lang.String style)
Set the value of the style
property.
Contents: Style rules to apply to the container DIV element.
setStyle
in interface IListControl
public java.lang.String getStyle()
Return the value of the style
property.
Contents: Style rules to apply to the container DIV element.
getStyle
in interface IListControl
public void setStyleClass(java.lang.String styleClass)
Set the value of the styleClass
property.
Contents: Style class to apply to the container DIV element.
setStyleClass
in interface IListControl
public java.lang.String getStyleClass()
Return the value of the styleClass
property.
Contents: Style class to apply to the container DIV element. Default = 'ui-widget-content ui-corner-all'.
getStyleClass
in interface IListControl
public void setRenderContext(java.lang.Object renderContext)
Set the value of the renderContext
property.
setRenderContext
in interface IListControl
public java.lang.Object getRenderContext()
Return the value of the renderContext
property.
getRenderContext
in interface IListControl
|
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 |