org.rcfaces.core.component
Class TreeComponent

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UIOutput
              extended by javax.faces.component.UIInput
                  extended by org.rcfaces.core.internal.component.CameliaInputComponent
                      extended by org.rcfaces.core.component.AbstractInputComponent
                          extended by org.rcfaces.core.component.TreeComponent
All Implemented Interfaces:
EditableValueHolder, StateHolder, ValueHolder, IAccessKeyCapability, IBorderCapability, ICardinality, ICheckableCapability, ICheckCardinalityCapability, ICheckedValuesCapability, ICheckEventCapability, IClientCheckFullStateCapability, IClientDataCapability, IClientFullStateCapability, IClientSelectionFullStateCapability, IDisabledCapability, IDoubleClickEventCapability, IDragEventCapability, IDraggableCapability, IDropCompleteEventCapability, IDropEventCapability, IDroppableCapability, IErrorEventCapability, IExpandableCapability, IExpandedValuesCapability, IExpandEventCapability, IFilterCapability, IFocusBlurEventCapability, IFontCapability, IForegroundBackgroundColorCapability, IHeightCapability, IHelpCapability, IHiddenModeCapability, IImmediateCapability, IInitEventCapability, IKeyDownEventCapability, IKeyEventCapability, IKeyPressEventCapability, IKeyUpEventCapability, ILayoutPositionCapability, ILoadEventCapability, ILookAndFeelCapability, IMarginCapability, IMenuCapability, IMouseEventCapability, IOverStyleClassCapability, IPartialRenderingCapability, IPositionCapability, IPreloadedLevelDepthCapability, IPreSelectionEventCapability, IPropertyChangeEventCapability, IReadOnlyCapability, IRequiredCapability, IScrollableCapability, ISelectableCapability, ISelectedValuesCapability, ISelectionCardinalityCapability, ISelectionEventCapability, IServerDataCapability, IShowValueCapability, ISizeCapability, IStyleClassCapability, ITabIndexCapability, ITextAlignmentCapability, IToolTipCapability, IUnlockedClientAttributesCapability, IUserEventCapability, IValidationEventCapability, IValueLockedCapability, IVisibilityCapability, IWAIRoleCapability, IWidthCapability, org.rcfaces.core.internal.capability.ICheckComponent, org.rcfaces.core.internal.capability.IComponentLifeCycle, org.rcfaces.core.internal.capability.IConvertValueHolder, org.rcfaces.core.internal.capability.IRCFacesComponent, org.rcfaces.core.internal.capability.ISelectionComponent, org.rcfaces.core.internal.capability.ISubmittedExternalValue, org.rcfaces.core.internal.manager.IClientDataManager, org.rcfaces.core.internal.manager.IContainerManager, org.rcfaces.core.internal.manager.IServerDataManager, org.rcfaces.core.internal.manager.ITransientAttributesManager, org.rcfaces.core.internal.tools.CollectionTools.IComponentValueTypeCapability, ICheckProvider, IExpansionProvider, ISelectionProvider

public class TreeComponent
extends AbstractInputComponent
implements IDoubleClickEventCapability, IRequiredCapability, IScrollableCapability, IBorderCapability, IReadOnlyCapability, IMenuCapability, IShowValueCapability, IOverStyleClassCapability, IFilterCapability, ILoadEventCapability, IExpandEventCapability, IPreSelectionEventCapability, IDragEventCapability, IDraggableCapability, IDropEventCapability, IDropCompleteEventCapability, IDroppableCapability, ICheckableCapability, ICheckCardinalityCapability, ICheckEventCapability, ICheckedValuesCapability, IClientCheckFullStateCapability, ISelectableCapability, ISelectionCardinalityCapability, ISelectionEventCapability, ISelectedValuesCapability, IClientSelectionFullStateCapability, IPreloadedLevelDepthCapability, IExpandableCapability, IExpandedValuesCapability, org.rcfaces.core.internal.capability.ICheckComponent, org.rcfaces.core.internal.capability.ISelectionComponent, org.rcfaces.core.internal.tools.CollectionTools.IComponentValueTypeCapability

The tree Component shows informations in an arborescent view. It can be compared to the tree found in most modern file explorer. It allows contextual menus ...

The tree Component has the following capabilities :

The default tree renderer is linked to the f_tree javascript class. f_tree extends f_component, fa_readOnly, fa_disabled, fa_immediate, fa_subMenu, fa_selectionManager, fa_checkManager, fa_itemClientDatas, fa_scrollPositions, fa_overStyleClass, fa_filterProperties, fa_droppable, fa_draggable, fa_autoScroll, fa_autoOpen

Table of component style classes:

Style Name Description
f_tree Defines styles for the wrapper DIV element
f_tree_body Defines styles for the wrapper UL element
f_tree_parent Defines styles for the wrapper LI element of the parent nodes
f_tree_depth Defines styles for the DIV element of the depth node
f_tree_node Defines styles for the DIV element of the node


Field Summary
protected static Set CAMELIA_ATTRIBUTES
           
protected static String CAMELIA_VALUE_ALIAS
           
static String COMPONENT_TYPE
           
 
Fields inherited from class org.rcfaces.core.internal.component.CameliaInputComponent
engine
 
Fields inherited from class javax.faces.component.UIInput
COMPONENT_FAMILY, CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID, UPDATE_MESSAGE_ID
 
Fields inherited from class javax.faces.component.UIComponent
bindings
 
Fields inherited from interface org.rcfaces.core.component.capability.ICheckCardinalityCapability
DEFAULT_CARDINALITY
 
Fields inherited from interface org.rcfaces.core.component.capability.ISelectionCardinalityCapability
DEFAULT_CARDINALITY
 
Fields inherited from interface org.rcfaces.core.component.capability.ICardinality
ONE_CARDINALITY, ONEMANY_CARDINALITY, OPTIONAL_CARDINALITY, ZEROMANY_CARDINALITY
 
Fields inherited from interface org.rcfaces.core.component.capability.IClientFullStateCapability
DEFAULT_CLIENT_FULL_STATE, FALSE_CLIENT_FULL_STATE, NONE_CLIENT_FULL_STATE, ONEWAY_CLIENT_FULL_STATE, TRUE_CLIENT_FULL_STATE, TWOWAYS_CLIENT_FULL_STATE
 
Fields inherited from interface org.rcfaces.core.component.capability.IHiddenModeCapability
CLIENT_HIDDEN_MODE, DEFAULT_HIDDEN_MODE, IGNORE_HIDDEN_MODE, PHANTOM_HIDDEN_MODE, SERVER_HIDDEN_MODE
 
Constructor Summary
TreeComponent()
           
TreeComponent(String componentId)
           
 
Method Summary
 void addCheckListener(ICheckListener listener)
          Adds a listener to the component for the checked event
 void addDoubleClickListener(IDoubleClickListener listener)
          Adds a listener to the component for the doubleClick event
 void addDragListener(IDragListener listener)
          Adds a listener to the component for the drag event
 void addDropCompleteListener(IDropCompleteListener listener)
          Adds a listener to the component for the drop event
 void addDropListener(IDropListener listener)
          Adds a listener to the component for the drop event
 void addExpandListener(IExpandListener listener)
          Adds a listener to the component for the expand event
 void addLoadListener(ILoadListener listener)
          Adds a listener to the component for the load event
 void addPreSelectionListener(IPreSelectionListener listener)
          Adds a listener to the component for the preSelection event
 void addSelectionListener(ISelectionListener listener)
          Adds a listener to the component for the selection event
 void check(Object rowValue)
           
 void checkAll()
           
 void collapse(Object value)
           
 void collapseAll()
           
 void collapseAll(FacesContext context)
           
 void deselect(Object rowValue)
           
 void deselectAll()
           
 void expand(Object value)
           
 void expandAll()
           
 void expandAll(FacesContext context)
           
protected  Set getCameliaFields()
           
protected  String getCameliaValueAlias()
           
 int getCheckCardinality()
          Returns an int value indicating the cardinality (number of check allowed) for this componenent.
 int getCheckCardinality(FacesContext facesContext)
          See getCheckCardinality() for more details
 Object getCheckedValues()
           
 Object getCheckedValues(FacesContext facesContext)
           
 int getCheckedValuesCount()
           
 Class getCheckedValuesType(FacesContext facesContext)
          Return the type of the property represented by the ValueExpression, relative to the specified FacesContext.
 int getClientCheckFullState()
          Returns an integer value indicating wether the client should know about the component's full state even if only a part of the data is present (AJAX).
 int getClientCheckFullState(FacesContext facesContext)
          See getClientCheckFullState() for more details
 int getClientSelectionFullState()
          Returns a boolean value indicating whether the client should know about the component's full state even if only a part of the data is present (AJAX).
 int getClientSelectionFullState(FacesContext facesContext)
          See getClientSelectionFullState() for more details
 org.rcfaces.core.internal.tools.CollectionTools.IComponentValueType getComponentValueType()
           
 Object getCursorValue()
           
 Object getCursorValue(FacesContext facesContext)
           
 String getDefaultCollapsedImageURL()
           
 String getDefaultCollapsedImageURL(FacesContext facesContext)
           
 String getDefaultDisabledImageURL()
          Returns an url string pointing to the default image for the disabled state.
 String getDefaultDisabledImageURL(FacesContext facesContext)
          Returns an url string pointing to the default image for the disabled state.
 String getDefaultDisabledLeafImageURL()
           
 String getDefaultDisabledLeafImageURL(FacesContext facesContext)
           
 String getDefaultExpandedImageURL()
          Returns an url string pointing to the default image for an expanded node.
 String getDefaultExpandedImageURL(FacesContext facesContext)
          Returns an url string pointing to the default image for an expanded node.
 String getDefaultExpandedLeafImageURL()
           
 String getDefaultExpandedLeafImageURL(FacesContext facesContext)
           
 String getDefaultImageURL()
          Returns an url string pointing to the default image.
 String getDefaultImageURL(FacesContext facesContext)
          Returns an url string pointing to the default image.
 String getDefaultLeafImageURL()
          Returns an url string pointing to the default image for a leaf.
 String getDefaultLeafImageURL(FacesContext facesContext)
          Returns an url string pointing to the default image for a leaf.
 String getDefaultSelectedImageURL()
          Returns an url string pointing to the default image for the selected state.
 String getDefaultSelectedImageURL(FacesContext facesContext)
          Returns an url string pointing to the default image for the selected state.
 String getDefaultSelectedLeafImageURL()
           
 String getDefaultSelectedLeafImageURL(FacesContext facesContext)
           
 int getDragEffects()
           
 int getDragEffects(FacesContext facesContext)
          See getDragEffects() for more details
 String[] getDragTypes()
           
 String[] getDragTypes(FacesContext facesContext)
          See getDragTypes() for more details
 int getDropEffects()
           
 int getDropEffects(FacesContext facesContext)
          See getDropEffects() for more details
 String[] getDropTypes()
           
 String[] getDropTypes(FacesContext facesContext)
          See getDropTypes() for more details
 Object getExpandedValues()
           
 Object getExpandedValues(FacesContext facesContext)
           
 int getExpandedValuesCount()
           
 Class getExpandedValuesType(FacesContext facesContext)
          Return the type of the property represented by the ValueExpression, relative to the specified FacesContext.
 IFilterProperties getFilterProperties()
          Return an object that represent the filter to use on the server side.
 IFilterProperties getFilterProperties(FacesContext facesContext)
          See getFilterProperties() for more details
 Object getFirstCheckedValue()
           
 Object getFirstSelectedValue()
           
 int getHorizontalScrollPosition()
          Returns an integer value specifying the position of the horizontal scroolbar (browser dependant).
 int getHorizontalScrollPosition(FacesContext facesContext)
          See getHorizontalScrollPosition() for more details
 IMenuComponent getMenu()
          Returns the top-most menu associated to the component.
 IMenuComponent getMenu(String menuId)
          Returns the menu identified by its id from the menus associated to the component.
 String getOverStyleClass()
           
 String getOverStyleClass(FacesContext facesContext)
          See getOverStyleClass() for more details
 int getPreloadedLevelDepth()
           
 int getPreloadedLevelDepth(FacesContext facesContext)
          See getPreloadedLevelDepth() for more details
 Object getSelectedValues()
           
 Object getSelectedValues(FacesContext facesContext)
           
 int getSelectedValuesCount()
           
 Class getSelectedValuesType(FacesContext facesContext)
          Return the type of the property represented by the ValueExpression, relative to the specified FacesContext.
 int getSelectionCardinality()
          Returns an int value specifying the type of multiple selection authorized. cf.
 int getSelectionCardinality(FacesContext facesContext)
          See getSelectionCardinality() for more details
 Object getShowValue()
           
 Object getShowValue(FacesContext facesContext)
          See getShowValue() for more details
 int getVerticalScrollPosition()
          Returns an integer value specifying the position of the vertical scroolbar (Browser dependant).
 int getVerticalScrollPosition(FacesContext facesContext)
          See getVerticalScrollPosition() for more details
 boolean isBodyDroppable()
           
 boolean isBodyDroppable(FacesContext facesContext)
           
 boolean isBodyDroppableSetted()
          Returns true if the attribute "bodyDroppable" is set.
 boolean isBorder()
          Returns a boolean value that indicates if the component should show a border or not.
 boolean isBorder(FacesContext facesContext)
          See isBorder() for more details
 boolean isBorderSetted()
          Returns true if the attribute "border" is set.
 boolean isCheckable()
          Returns a boolean value indicating whether the component can be checked.
 boolean isCheckable(FacesContext facesContext)
          See isCheckable() for more details
 boolean isCheckableSetted()
          Returns true if the attribute "checkable" is set.
 boolean isCheckCardinalitySetted()
          Returns true if the attribute "checkCardinality" is set.
 boolean isCheckedValuesSetted()
          Returns true if the attribute "checkedValues" is set.
 boolean isClientCheckFullStateSetted()
          Returns true if the attribute "clientCheckFullState" is set.
 boolean isClientSelectionFullStateSetted()
          Returns true if the attribute "clientSelectionFullState" is set.
 boolean isCursorValueSetted()
          Returns true if the attribute "cursorValue" is set.
 boolean isDefaultCollapsedImageURLSetted()
          Returns true if the attribute "defaultCollapsedImageURL" is set.
 boolean isDefaultDisabledImageURLSetted()
          Returns true if the attribute "defaultDisabledImageURL" is set.
 boolean isDefaultDisabledLeafImageURLSetted()
          Returns true if the attribute "defaultDisabledLeafImageURL" is set.
 boolean isDefaultExpandedImageURLSetted()
          Returns true if the attribute "defaultExpandedImageURL" is set.
 boolean isDefaultExpandedLeafImageURLSetted()
          Returns true if the attribute "defaultExpandedLeafImageURL" is set.
 boolean isDefaultImageURLSetted()
          Returns true if the attribute "defaultImageURL" is set.
 boolean isDefaultLeafImageURLSetted()
          Returns true if the attribute "defaultLeafImageURL" is set.
 boolean isDefaultSelectedImageURLSetted()
          Returns true if the attribute "defaultSelectedImageURL" is set.
 boolean isDefaultSelectedLeafImageURLSetted()
          Returns true if the attribute "defaultSelectedLeafImageURL" is set.
 boolean isDragEffectsSetted()
          Returns true if the attribute "dragEffects" is set.
 boolean isDraggable()
           
 boolean isDraggable(FacesContext facesContext)
          See isDraggable() for more details
 boolean isDraggableSetted()
          Returns true if the attribute "draggable" is set.
 boolean isDragTypesSetted()
          Returns true if the attribute "dragTypes" is set.
 boolean isDropEffectsSetted()
          Returns true if the attribute "dropEffects" is set.
 boolean isDroppable()
           
 boolean isDroppable(FacesContext facesContext)
          See isDroppable() for more details
 boolean isDroppableSetted()
          Returns true if the attribute "droppable" is set.
 boolean isDropTypesSetted()
          Returns true if the attribute "dropTypes" is set.
 boolean isExpandable()
          Returns a boolean value indicating wether the component can receive a user's expand command.
 boolean isExpandable(FacesContext facesContext)
          See isExpandable() for more details
 boolean isExpandableSetted()
          Returns true if the attribute "expandable" is set.
 boolean isExpanded(FacesContext context, Object value)
           
 boolean isExpandedValuesSetted()
          Returns true if the attribute "expandedValues" is set.
 boolean isExpansionUseValue()
          Returns a boolean value that indicates wether a node is identified by it's value or by a complete path.
 boolean isExpansionUseValue(FacesContext facesContext)
          Returns a boolean value that indicates wether a node is identified by it's value or by a complete path.
 boolean isExpansionUseValueSetted()
          Returns true if the attribute "expansionUseValue" is set.
 boolean isFilterPropertiesSetted()
          Returns true if the attribute "filterProperties" is set.
 boolean isHideRootExpandSign()
          Returns a boolean value indicating wether the expand sign should be visible for the topmost node.
 boolean isHideRootExpandSign(FacesContext facesContext)
          Returns a boolean value indicating wether the expand sign should be visible for the topmost node.
 boolean isHideRootExpandSignSetted()
          Returns true if the attribute "hideRootExpandSign" is set.
 boolean isHorizontalScrollPositionSetted()
          Returns true if the attribute "horizontalScrollPosition" is set.
 boolean isOverStyleClassSetted()
          Returns true if the attribute "overStyleClass" is set.
 boolean isPreloadedLevelDepthSetted()
          Returns true if the attribute "preloadedLevelDepth" is set.
 boolean isReadOnly()
          Returns a boolean value indicating that this component will prohibit changes by the user.
 boolean isReadOnly(FacesContext facesContext)
          See isReadOnly() for more details
 boolean isReadOnlySetted()
          Returns true if the attribute "readOnly" is set.
 boolean isSelectable()
          Returns a boolean value indicating wether the component can receive a user's selection
 boolean isSelectable(FacesContext facesContext)
          See isSelectable() for more details
 boolean isSelectableSetted()
          Returns true if the attribute "selectable" is set.
 boolean isSelectedValuesSetted()
          Returns true if the attribute "selectedValues" is set.
 boolean isSelectionCardinalitySetted()
          Returns true if the attribute "selectionCardinality" is set.
 boolean isShowValueSetted()
          Returns true if the attribute "showValue" is set.
 boolean isVerticalScrollPositionSetted()
          Returns true if the attribute "verticalScrollPosition" is set.
 Object[] listCheckedValues()
           
 FacesListener[] listCheckListeners()
          Returns the list of check listener for the component
 FacesListener[] listDoubleClickListeners()
          Returns a list of doubleClick listener for the component
 FacesListener[] listDragListeners()
          Returns a list of drag listener for the component
 FacesListener[] listDropCompleteListeners()
          Returns a list of drop listeners for the component
 FacesListener[] listDropListeners()
          Returns a list of drop listeners for the component
 Object[] listExpandedValues()
           
 FacesListener[] listExpandListeners()
          Returns a list of expand listener for the component
 FacesListener[] listLoadListeners()
          Returns a list of load listener for the component
 IMenuIterator listMenus()
          Returns a list of all the menus associated to the component.
 FacesListener[] listPreSelectionListeners()
          Returns a list of PreSelection listener for the component
 Object[] listSelectedValues()
           
 FacesListener[] listSelectionListeners()
          Returns a list of selection listener for the component
 void removeAllTreeNodes()
           
 void removeCheckListener(ICheckListener listener)
          Removes a listener from the list of listeners
 void removeDoubleClickListener(IDoubleClickListener listener)
          Removes a listener from the component for the doubleClick event
 void removeDragListener(IDragListener listener)
          Removes a listener from the component for the drag event
 void removeDropCompleteListener(IDropCompleteListener listener)
          Removes a listener from the component for the drop event
 void removeDropListener(IDropListener listener)
          Removes a listener from the component for the drop event
 void removeExpandListener(IExpandListener listener)
          Removes a listener from the component for the expand event
 void removeLoadListener(ILoadListener listener)
          Removes a listener from the component for the load event
 void removePreSelectionListener(IPreSelectionListener listener)
          Removes a listener from the component for the preSelection event
 void removeSelectionListener(ISelectionListener listener)
          Removes a listener from the component for the selection event
 void select(Object rowValue)
           
 void selectAll()
           
 void setBodyDroppable(boolean bodyDroppable)
           
 void setBorder(boolean border)
          Sets a boolean value that indicates if the component should show a border or not.
 void setCheckable(boolean checkable)
          Sets a boolean value indicating whether the component can be checked.
 void setCheckCardinality(int checkCardinality)
          Sets an int value indicating the cardinality (number of check allowed) for this componenent.
 void setCheckCardinality(String cardinality)
           
 void setCheckedValues(Object checkedValues)
           
 void setClientCheckFullState(int clientCheckFullState)
          Sets a boolean value indicating wether the client should know about the component's full state even if only a part of the data is present (AJAX).
 void setClientCheckFullState(String state)
           
 void setClientSelectionFullState(int clientSelectionFullState)
          Sets a boolean value indicating whether the client should know about the component's full state even if only a part of the data is present (AJAX).
 void setClientSelectionFullState(String state)
           
 void setCursorValue(Object cursorValue)
           
 void setDefaultCollapsedImageURL(String defaultCollapsedImageURL)
           
 void setDefaultDisabledImageURL(String defaultDisabledImageURL)
          Sets an url string pointing to the default image for the disabled state.
 void setDefaultDisabledLeafImageURL(String defaultDisabledLeafImageURL)
           
 void setDefaultExpandedImageURL(String defaultExpandedImageURL)
          Sets an url string pointing to the default image for an expanded node.
 void setDefaultExpandedLeafImageURL(String defaultExpandedLeafImageURL)
           
 void setDefaultImageURL(String defaultImageURL)
          Sets an url string pointing to the default image.
 void setDefaultLeafImageURL(String defaultLeafImageURL)
          Sets an url string pointing to the default image for a leaf.
 void setDefaultSelectedImageURL(String defaultSelectedImageURL)
          Sets an url string pointing to the default image for the selected state.
 void setDefaultSelectedLeafImageURL(String defaultSelectedLeafImageURL)
           
 void setDragEffects(int dragEffects)
           
 void setDragEffects(String dragEffects)
           
 void setDraggable(boolean draggable)
           
 void setDragTypes(String dragTypes)
           
 void setDragTypes(String[] dragTypes)
           
 void setDropEffects(int dropEffects)
           
 void setDropEffects(String dropEffects)
           
 void setDroppable(boolean droppable)
           
 void setDropTypes(String dropTypes)
           
 void setDropTypes(String[] dropTypes)
           
 void setExpandable(boolean expandable)
          Sets a boolean value indicating wether the component can receive a user's expand command.
 void setExpanded(FacesContext context, Object value, boolean expanded)
           
 void setExpanded(Object value, boolean expanded)
           
 void setExpandedValues(Object expandedValues)
           
 void setExpansionUseValue(boolean expansionUseValue)
          Sets a boolean value that indicates wether a node is identified by it's value or by a complete path.
 void setFilterProperties(IFilterProperties filterProperties)
          Sets an object that represent the filter to use on the server side.
 void setFilterProperties(String properties)
           
 void setHideRootExpandSign(boolean hideRootExpandSign)
          Sets a boolean value indicating wether the expand sign should be visible for the topmost node.
 void setHorizontalScrollPosition(int horizontalScrollPosition)
          Sets an integer value specifying the position of the horizontal scroolbar (browser dependant).
 void setOverStyleClass(String overStyleClass)
           
 void setPreloadedLevelDepth(int preloadedLevelDepth)
           
 void setReadOnly(boolean readOnly)
          Sets a boolean value indicating that this component will prohibit changes by the user.
 void setSelectable(boolean selectable)
          Sets a boolean value indicating wether the component can receive a user's selection
 void setSelectedValues(Object selectedValues)
           
 void setSelectionCardinality(int selectionCardinality)
          Sets an int value specifying the type of multiple selection authorized.
 void setSelectionCardinality(String cardinality)
           
 void setShowValue(Object showValue)
          Set the value of the item will be shown.
 void setVerticalScrollPosition(int verticalScrollPosition)
          Sets an integer value specifying the position of the vertical scroolbar (Browser dependant).
 void uncheck(Object rowValue)
           
 void uncheckAll()
           
 
Methods inherited from class org.rcfaces.core.component.AbstractInputComponent
addBlurListener, addErrorListener, addFocusListener, addInitListener, addKeyDownListener, addKeyPressListener, addKeyUpListener, addMouseOutListener, addMouseOverListener, addPropertyChangeListener, addUserEventListener, addValidationListener, getAccessKey, getAccessKey, getAriaLabel, getAriaLabel, getAriaLevel, getAriaLevel, getBackgroundColor, getBackgroundColor, getBottom, getBottom, getClientData, getClientData, getClientDataCount, getClientDataMap, getClientDataMap, getFontBold, getFontBold, getFontItalic, getFontItalic, getFontName, getFontName, getFontSize, getFontSize, getFontUnderline, getFontUnderline, getForegroundColor, getForegroundColor, getHeight, getHeight, getHelpMessage, getHelpMessage, getHelpURL, getHelpURL, getHiddenMode, getHiddenMode, getLeft, getLeft, getLookId, getLookId, getMarginBottom, getMarginBottom, getMarginLeft, getMarginLeft, getMarginRight, getMarginRight, getMarginTop, getMarginTop, getRight, getRight, getServerData, getServerData, getServerDataCount, getServerDataMap, getServerDataMap, getStyleClass, getStyleClass, getTabIndex, getTabIndex, getTextAlignment, getTextAlignment, getToolTipText, getToolTipText, getTop, getTop, getUnlockedClientAttributeNames, getUnlockedClientAttributeNames, getVisibleState, getVisibleState, getWaiRole, getWaiRole, getWidth, getWidth, getX, getX, getY, getY, isAccessKeySetted, isAriaLabelSetted, isAriaLevelSetted, isBackgroundColorSetted, isBottomSetted, isDisabled, isDisabled, isDisabledSetted, isFontBoldSetted, isFontItalicSetted, isFontNameSetted, isFontSizeSetted, isFontUnderlineSetted, isForegroundColorSetted, isHeightSetted, isHelpMessageSetted, isHelpURLSetted, isHiddenModeSetted, isLeftSetted, isLookIdSetted, isMarginBottomSetted, isMarginLeftSetted, isMarginRightSetted, isMarginTopSetted, isPartialRendering, isPartialRendering, isPartialRenderingSetted, isRightSetted, isStyleClassSetted, isTabIndexSetted, isTextAlignmentSetted, isToolTipTextSetted, isTopSetted, isUnlockedClientAttributeNamesSetted, isValueLocked, isValueLocked, isValueLockedSetted, isVisible, isVisible, isVisibleSetted, isWaiRoleSetted, isWidthSetted, isXSetted, isYSetted, listBlurListeners, listClientDataKeys, listClientDataKeys, listErrorListeners, listFocusListeners, listInitListeners, listKeyDownListeners, listKeyPressListeners, listKeyUpListeners, listMouseOutListeners, listMouseOverListeners, listPropertyChangeListeners, listServerDataKeys, listServerDataKeys, listUserEventListeners, listValidationListeners, removeBlurListener, removeClientData, removeErrorListener, removeFocusListener, removeInitListener, removeKeyDownListener, removeKeyPressListener, removeKeyUpListener, removeMouseOutListener, removeMouseOverListener, removePropertyChangeListener, removeServerData, removeUserEventListener, removeValidationListener, setAccessKey, setAriaLabel, setAriaLevel, setBackgroundColor, setBottom, setClientData, setClientData, setDisabled, setFontBold, setFontItalic, setFontName, setFontSize, setFontUnderline, setForegroundColor, setHeight, setHelpMessage, setHelpURL, setHiddenMode, setHiddenMode, setLeft, setLookId, setMarginBottom, setMarginLeft, setMarginRight, setMargins, setMarginTop, setPartialRendering, setRight, setServerData, setServerData, setStyleClass, setTabIndex, setTextAlignment, setToolTipText, setTop, setUnlockedClientAttributeNames, setValueLocked, setVisible, setWaiRole, setWidth, setX, setY
 
Methods inherited from class org.rcfaces.core.internal.component.CameliaInputComponent
broadcast, clearListeners, confirmListenerAppend, constructPhase, constructTemplate, decodePhase, encodeBegin, encodeChildren, encodeEnd, getAsyncRenderer, getChildren, getChildrenListState, getConvertedValue, getFamily, getLocalValue, getRendererType, getSubmittedExternalValue, getTransientAttribute, getValue, getValueExpression, hasDefaultProperties, initializeComponent, initializePhase, isClientRendered, isRendered, isSubmittedValueSetted, isTemplateComponent, processDecodes, processEngineUpdates, processEngineValidators, processUpdates, processValidators, queueEvent, renderPhase, restoreState, saveState, setConverter, setConverter, setDefaultProperties, setRendered, setSubmittedExternalValue, setTransientAttribute, setValueExpression, toString, updatePhase, validationPhase, verifyAsyncDecode
 
Methods inherited from class javax.faces.component.UIInput
addValidator, addValueChangeListener, compareValues, decode, getConverterMessage, getRequiredMessage, getSubmittedValue, getValidator, getValidatorMessage, getValidators, getValueChangeListener, getValueChangeListeners, isImmediate, isLocalValueSet, isRequired, isValid, removeValidator, removeValueChangeListener, resetValue, setConverterMessage, setImmediate, setLocalValueSet, setRequired, setRequiredMessage, setSubmittedValue, setValid, setValidator, setValidatorMessage, setValue, setValueChangeListener, updateModel, validate, validateValue
 
Methods inherited from class javax.faces.component.UIOutput
getConverter, setConverter
 
Methods inherited from class javax.faces.component.UIComponentBase
addFacesListener, findComponent, getAttributes, getChildCount, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendersChildren, getValueBinding, invokeOnComponent, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding
 
Methods inherited from class javax.faces.component.UIComponent
encodeAll, getContainerClientId
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.rcfaces.core.component.capability.IRequiredCapability
isRequired, setRequired
 
Methods inherited from interface org.rcfaces.core.component.capability.IImmediateCapability
isImmediate, setImmediate
 
Methods inherited from interface org.rcfaces.core.internal.manager.IContainerManager
getChildCount
 
Methods inherited from interface javax.faces.component.ValueHolder
getConverter, setConverter, setValue
 

Field Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE
See Also:
Constant Field Values

CAMELIA_ATTRIBUTES

protected static final Set CAMELIA_ATTRIBUTES

CAMELIA_VALUE_ALIAS

protected static final String CAMELIA_VALUE_ALIAS
See Also:
Constant Field Values
Constructor Detail

TreeComponent

public TreeComponent()

TreeComponent

public TreeComponent(String componentId)
Method Detail

setDragEffects

public void setDragEffects(String dragEffects)

setDragTypes

public void setDragTypes(String dragTypes)

setDropEffects

public void setDropEffects(String dropEffects)

setDropTypes

public void setDropTypes(String dropTypes)

setClientSelectionFullState

public void setClientSelectionFullState(String state)

setClientCheckFullState

public void setClientCheckFullState(String state)

setFilterProperties

public void setFilterProperties(String properties)

getComponentValueType

public org.rcfaces.core.internal.tools.CollectionTools.IComponentValueType getComponentValueType()
Specified by:
getComponentValueType in interface org.rcfaces.core.internal.tools.CollectionTools.IComponentValueTypeCapability

setSelectionCardinality

public void setSelectionCardinality(String cardinality)

setCheckCardinality

public void setCheckCardinality(String cardinality)

removeAllTreeNodes

public void removeAllTreeNodes()

select

public void select(Object rowValue)
Specified by:
select in interface org.rcfaces.core.internal.capability.ISelectionComponent

selectAll

public void selectAll()
Specified by:
selectAll in interface org.rcfaces.core.internal.capability.ISelectionComponent

deselect

public void deselect(Object rowValue)
Specified by:
deselect in interface org.rcfaces.core.internal.capability.ISelectionComponent

deselectAll

public void deselectAll()
Specified by:
deselectAll in interface org.rcfaces.core.internal.capability.ISelectionComponent

check

public void check(Object rowValue)
Specified by:
check in interface org.rcfaces.core.internal.capability.ICheckComponent

checkAll

public void checkAll()
Specified by:
checkAll in interface org.rcfaces.core.internal.capability.ICheckComponent

uncheck

public void uncheck(Object rowValue)
Specified by:
uncheck in interface org.rcfaces.core.internal.capability.ICheckComponent

uncheckAll

public void uncheckAll()
Specified by:
uncheckAll in interface org.rcfaces.core.internal.capability.ICheckComponent

collapseAll

public void collapseAll()

collapseAll

public void collapseAll(FacesContext context)

expandAll

public void expandAll()

expandAll

public void expandAll(FacesContext context)

setExpanded

public void setExpanded(FacesContext context,
                        Object value,
                        boolean expanded)

expand

public void expand(Object value)

collapse

public void collapse(Object value)

setExpanded

public void setExpanded(Object value,
                        boolean expanded)

isExpanded

public boolean isExpanded(FacesContext context,
                          Object value)

getCursorValue

public Object getCursorValue(FacesContext facesContext)

getSelectedValues

public Object getSelectedValues(FacesContext facesContext)

setSelectedValues

public void setSelectedValues(Object selectedValues)
Specified by:
setSelectedValues in interface ISelectionProvider

getCheckedValues

public Object getCheckedValues(FacesContext facesContext)

setCheckedValues

public void setCheckedValues(Object checkedValues)
Specified by:
setCheckedValues in interface ICheckProvider

getExpandedValues

public Object getExpandedValues(FacesContext facesContext)

setExpandedValues

public void setExpandedValues(Object expandedValues)
Specified by:
setExpandedValues in interface IExpansionProvider

addDoubleClickListener

public final void addDoubleClickListener(IDoubleClickListener listener)
Description copied from interface: IDoubleClickEventCapability
Adds a listener to the component for the doubleClick event

Specified by:
addDoubleClickListener in interface IDoubleClickEventCapability
Parameters:
listener - the doubleClick listener to add

removeDoubleClickListener

public final void removeDoubleClickListener(IDoubleClickListener listener)
Description copied from interface: IDoubleClickEventCapability
Removes a listener from the component for the doubleClick event

Specified by:
removeDoubleClickListener in interface IDoubleClickEventCapability
Parameters:
listener - the doubleClick listener to remove

listDoubleClickListeners

public final FacesListener[] listDoubleClickListeners()
Description copied from interface: IDoubleClickEventCapability
Returns a list of doubleClick listener for the component

Specified by:
listDoubleClickListeners in interface IDoubleClickEventCapability
Returns:
doubleClick listeners' list

getHorizontalScrollPosition

public int getHorizontalScrollPosition()
Description copied from interface: IScrollableCapability
Returns an integer value specifying the position of the horizontal scroolbar (browser dependant).

Specified by:
getHorizontalScrollPosition in interface IScrollableCapability
Returns:
horizontal scroll position

getHorizontalScrollPosition

public int getHorizontalScrollPosition(FacesContext facesContext)
See getHorizontalScrollPosition() for more details


isHorizontalScrollPositionSetted

public final boolean isHorizontalScrollPositionSetted()
Returns true if the attribute "horizontalScrollPosition" is set.

Returns:
true if the attribute is set.

setHorizontalScrollPosition

public void setHorizontalScrollPosition(int horizontalScrollPosition)
Description copied from interface: IScrollableCapability
Sets an integer value specifying the position of the horizontal scroolbar (browser dependant).

Specified by:
setHorizontalScrollPosition in interface IScrollableCapability
Parameters:
horizontalScrollPosition - horizontal scroll position

getVerticalScrollPosition

public int getVerticalScrollPosition()
Description copied from interface: IScrollableCapability
Returns an integer value specifying the position of the vertical scroolbar (Browser dependant).

Specified by:
getVerticalScrollPosition in interface IScrollableCapability
Returns:
vertical scroll position

getVerticalScrollPosition

public int getVerticalScrollPosition(FacesContext facesContext)
See getVerticalScrollPosition() for more details


isVerticalScrollPositionSetted

public final boolean isVerticalScrollPositionSetted()
Returns true if the attribute "verticalScrollPosition" is set.

Returns:
true if the attribute is set.

setVerticalScrollPosition

public void setVerticalScrollPosition(int verticalScrollPosition)
Description copied from interface: IScrollableCapability
Sets an integer value specifying the position of the vertical scroolbar (Browser dependant).

Specified by:
setVerticalScrollPosition in interface IScrollableCapability
Parameters:
verticalScrollPosition - vertical scroll position

isBorder

public boolean isBorder()
Description copied from interface: IBorderCapability
Returns a boolean value that indicates if the component should show a border or not.

Specified by:
isBorder in interface IBorderCapability
Returns:
border

isBorder

public boolean isBorder(FacesContext facesContext)
See isBorder() for more details


isBorderSetted

public final boolean isBorderSetted()
Returns true if the attribute "border" is set.

Returns:
true if the attribute is set.

setBorder

public void setBorder(boolean border)
Description copied from interface: IBorderCapability
Sets a boolean value that indicates if the component should show a border or not.

Specified by:
setBorder in interface IBorderCapability
Parameters:
border - boolean

isReadOnly

public boolean isReadOnly()
Description copied from interface: IReadOnlyCapability
Returns a boolean value indicating that this component will prohibit changes by the user. The element may receive focus unless it has also been disabled.

Specified by:
isReadOnly in interface IReadOnlyCapability
Returns:
readOnly boolean property

isReadOnly

public boolean isReadOnly(FacesContext facesContext)
See isReadOnly() for more details


isReadOnlySetted

public final boolean isReadOnlySetted()
Returns true if the attribute "readOnly" is set.

Returns:
true if the attribute is set.

setReadOnly

public void setReadOnly(boolean readOnly)
Description copied from interface: IReadOnlyCapability
Sets a boolean value indicating that this component will prohibit changes by the user. The element may receive focus unless it has also been disabled.

Specified by:
setReadOnly in interface IReadOnlyCapability
Parameters:
readOnly - readOnly boolean property

getMenu

public IMenuComponent getMenu()
Description copied from interface: IMenuCapability
Returns the top-most menu associated to the component.

Specified by:
getMenu in interface IMenuCapability
Returns:
top-most menu component

getMenu

public IMenuComponent getMenu(String menuId)
Description copied from interface: IMenuCapability
Returns the menu identified by its id from the menus associated to the component.

Specified by:
getMenu in interface IMenuCapability
Parameters:
menuId - Id for a particular menu
Returns:
menu component

listMenus

public IMenuIterator listMenus()
Description copied from interface: IMenuCapability
Returns a list of all the menus associated to the component.

Specified by:
listMenus in interface IMenuCapability
Returns:
Menu iterator

getShowValue

public Object getShowValue()
Specified by:
getShowValue in interface IShowValueCapability
Returns:
The value of the item will be shown.

getShowValue

public Object getShowValue(FacesContext facesContext)
See getShowValue() for more details


isShowValueSetted

public final boolean isShowValueSetted()
Returns true if the attribute "showValue" is set.

Returns:
true if the attribute is set.

setShowValue

public void setShowValue(Object showValue)
Description copied from interface: IShowValueCapability
Set the value of the item will be shown.

Specified by:
setShowValue in interface IShowValueCapability
Parameters:
showValue - The value of the item

getOverStyleClass

public String getOverStyleClass()
Specified by:
getOverStyleClass in interface IOverStyleClassCapability

getOverStyleClass

public String getOverStyleClass(FacesContext facesContext)
See getOverStyleClass() for more details


isOverStyleClassSetted

public final boolean isOverStyleClassSetted()
Returns true if the attribute "overStyleClass" is set.

Returns:
true if the attribute is set.

setOverStyleClass

public void setOverStyleClass(String overStyleClass)
Specified by:
setOverStyleClass in interface IOverStyleClassCapability

getFilterProperties

public IFilterProperties getFilterProperties()
Description copied from interface: IFilterCapability
Return an object that represent the filter to use on the server side.

Specified by:
getFilterProperties in interface IFilterCapability
Returns:
filter

getFilterProperties

public IFilterProperties getFilterProperties(FacesContext facesContext)
See getFilterProperties() for more details


isFilterPropertiesSetted

public final boolean isFilterPropertiesSetted()
Returns true if the attribute "filterProperties" is set.

Returns:
true if the attribute is set.

setFilterProperties

public void setFilterProperties(IFilterProperties filterProperties)
Description copied from interface: IFilterCapability
Sets an object that represent the filter to use on the server side.

Specified by:
setFilterProperties in interface IFilterCapability
Parameters:
filterProperties - filter

addLoadListener

public final void addLoadListener(ILoadListener listener)
Description copied from interface: ILoadEventCapability
Adds a listener to the component for the load event

Specified by:
addLoadListener in interface ILoadEventCapability
Parameters:
listener - the load listener to add

removeLoadListener

public final void removeLoadListener(ILoadListener listener)
Description copied from interface: ILoadEventCapability
Removes a listener from the component for the load event

Specified by:
removeLoadListener in interface ILoadEventCapability
Parameters:
listener - the load listener to remove

listLoadListeners

public final FacesListener[] listLoadListeners()
Description copied from interface: ILoadEventCapability
Returns a list of load listener for the component

Specified by:
listLoadListeners in interface ILoadEventCapability
Returns:
load listeners' list

addExpandListener

public final void addExpandListener(IExpandListener listener)
Description copied from interface: IExpandEventCapability
Adds a listener to the component for the expand event

Specified by:
addExpandListener in interface IExpandEventCapability
Parameters:
listener - the expand listener to add

removeExpandListener

public final void removeExpandListener(IExpandListener listener)
Description copied from interface: IExpandEventCapability
Removes a listener from the component for the expand event

Specified by:
removeExpandListener in interface IExpandEventCapability
Parameters:
listener - the expand listener to remove

listExpandListeners

public final FacesListener[] listExpandListeners()
Description copied from interface: IExpandEventCapability
Returns a list of expand listener for the component

Specified by:
listExpandListeners in interface IExpandEventCapability
Returns:
expand listeners' list

addPreSelectionListener

public final void addPreSelectionListener(IPreSelectionListener listener)
Description copied from interface: IPreSelectionEventCapability
Adds a listener to the component for the preSelection event

Specified by:
addPreSelectionListener in interface IPreSelectionEventCapability
Parameters:
listener - the preSelection listener to add

removePreSelectionListener

public final void removePreSelectionListener(IPreSelectionListener listener)
Description copied from interface: IPreSelectionEventCapability
Removes a listener from the component for the preSelection event

Specified by:
removePreSelectionListener in interface IPreSelectionEventCapability
Parameters:
listener - the PreSelection listener to remove

listPreSelectionListeners

public final FacesListener[] listPreSelectionListeners()
Description copied from interface: IPreSelectionEventCapability
Returns a list of PreSelection listener for the component

Specified by:
listPreSelectionListeners in interface IPreSelectionEventCapability
Returns:
preSelection listeners' list

addDragListener

public final void addDragListener(IDragListener listener)
Description copied from interface: IDragEventCapability
Adds a listener to the component for the drag event

Specified by:
addDragListener in interface IDragEventCapability
Parameters:
listener - the drag listener to add

removeDragListener

public final void removeDragListener(IDragListener listener)
Description copied from interface: IDragEventCapability
Removes a listener from the component for the drag event

Specified by:
removeDragListener in interface IDragEventCapability
Parameters:
listener - the drag listener to remove

listDragListeners

public final FacesListener[] listDragListeners()
Description copied from interface: IDragEventCapability
Returns a list of drag listener for the component

Specified by:
listDragListeners in interface IDragEventCapability
Returns:
drag listeners' list

getDragEffects

public int getDragEffects()
Specified by:
getDragEffects in interface IDraggableCapability

getDragEffects

public int getDragEffects(FacesContext facesContext)
See getDragEffects() for more details


isDragEffectsSetted

public final boolean isDragEffectsSetted()
Returns true if the attribute "dragEffects" is set.

Returns:
true if the attribute is set.

setDragEffects

public void setDragEffects(int dragEffects)
Specified by:
setDragEffects in interface IDraggableCapability

getDragTypes

public String[] getDragTypes()
Specified by:
getDragTypes in interface IDraggableCapability

getDragTypes

public String[] getDragTypes(FacesContext facesContext)
See getDragTypes() for more details


isDragTypesSetted

public final boolean isDragTypesSetted()
Returns true if the attribute "dragTypes" is set.

Returns:
true if the attribute is set.

setDragTypes

public void setDragTypes(String[] dragTypes)
Specified by:
setDragTypes in interface IDraggableCapability

isDraggable

public boolean isDraggable()
Specified by:
isDraggable in interface IDraggableCapability

isDraggable

public boolean isDraggable(FacesContext facesContext)
See isDraggable() for more details


isDraggableSetted

public final boolean isDraggableSetted()
Returns true if the attribute "draggable" is set.

Returns:
true if the attribute is set.

setDraggable

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

addDropListener

public final void addDropListener(IDropListener listener)
Description copied from interface: IDropEventCapability
Adds a listener to the component for the drop event

Specified by:
addDropListener in interface IDropEventCapability
Parameters:
listener - the drop listener to add

removeDropListener

public final void removeDropListener(IDropListener listener)
Description copied from interface: IDropEventCapability
Removes a listener from the component for the drop event

Specified by:
removeDropListener in interface IDropEventCapability
Parameters:
listener - the drop listener to remove

listDropListeners

public final FacesListener[] listDropListeners()
Description copied from interface: IDropEventCapability
Returns a list of drop listeners for the component

Specified by:
listDropListeners in interface IDropEventCapability
Returns:
drop listeners' list

addDropCompleteListener

public final void addDropCompleteListener(IDropCompleteListener listener)
Description copied from interface: IDropCompleteEventCapability
Adds a listener to the component for the drop event

Specified by:
addDropCompleteListener in interface IDropCompleteEventCapability
Parameters:
listener - the drop listener to add

removeDropCompleteListener

public final void removeDropCompleteListener(IDropCompleteListener listener)
Description copied from interface: IDropCompleteEventCapability
Removes a listener from the component for the drop event

Specified by:
removeDropCompleteListener in interface IDropCompleteEventCapability
Parameters:
listener - the drop listener to remove

listDropCompleteListeners

public final FacesListener[] listDropCompleteListeners()
Description copied from interface: IDropCompleteEventCapability
Returns a list of drop listeners for the component

Specified by:
listDropCompleteListeners in interface IDropCompleteEventCapability
Returns:
drop listeners' list

getDropEffects

public int getDropEffects()
Specified by:
getDropEffects in interface IDroppableCapability

getDropEffects

public int getDropEffects(FacesContext facesContext)
See getDropEffects() for more details


isDropEffectsSetted

public final boolean isDropEffectsSetted()
Returns true if the attribute "dropEffects" is set.

Returns:
true if the attribute is set.

setDropEffects

public void setDropEffects(int dropEffects)
Specified by:
setDropEffects in interface IDroppableCapability

getDropTypes

public String[] getDropTypes()
Specified by:
getDropTypes in interface IDroppableCapability

getDropTypes

public String[] getDropTypes(FacesContext facesContext)
See getDropTypes() for more details


isDropTypesSetted

public final boolean isDropTypesSetted()
Returns true if the attribute "dropTypes" is set.

Returns:
true if the attribute is set.

setDropTypes

public void setDropTypes(String[] dropTypes)
Specified by:
setDropTypes in interface IDroppableCapability

isDroppable

public boolean isDroppable()
Specified by:
isDroppable in interface IDroppableCapability

isDroppable

public boolean isDroppable(FacesContext facesContext)
See isDroppable() for more details


isDroppableSetted

public final boolean isDroppableSetted()
Returns true if the attribute "droppable" is set.

Returns:
true if the attribute is set.

setDroppable

public void setDroppable(boolean droppable)
Specified by:
setDroppable in interface IDroppableCapability

isCheckable

public boolean isCheckable()
Description copied from interface: ICheckableCapability
Returns a boolean value indicating whether the component can be checked.

Specified by:
isCheckable in interface ICheckableCapability
Returns:
boolean

isCheckable

public boolean isCheckable(FacesContext facesContext)
See isCheckable() for more details


isCheckableSetted

public final boolean isCheckableSetted()
Returns true if the attribute "checkable" is set.

Returns:
true if the attribute is set.

setCheckable

public void setCheckable(boolean checkable)
Description copied from interface: ICheckableCapability
Sets a boolean value indicating whether the component can be checked.

Specified by:
setCheckable in interface ICheckableCapability
Parameters:
checkable - boolean

getCheckCardinality

public int getCheckCardinality()
Description copied from interface: ICheckCardinalityCapability
Returns an int value indicating the cardinality (number of check allowed) for this componenent.

Specified by:
getCheckCardinality in interface ICheckCardinalityCapability
Returns:
1:?,optional|2:*,zeroMany|3:1,one+|4:+,oneMany

getCheckCardinality

public int getCheckCardinality(FacesContext facesContext)
See getCheckCardinality() for more details


isCheckCardinalitySetted

public final boolean isCheckCardinalitySetted()
Returns true if the attribute "checkCardinality" is set.

Returns:
true if the attribute is set.

setCheckCardinality

public void setCheckCardinality(int checkCardinality)
Description copied from interface: ICheckCardinalityCapability
Sets an int value indicating the cardinality (number of check allowed) for this componenent.

Specified by:
setCheckCardinality in interface ICheckCardinalityCapability
Parameters:
checkCardinality - 1:?,optional|2:*,zeroMany|3:1,one+|4:+,oneMany default=zeroMany

addCheckListener

public final void addCheckListener(ICheckListener listener)
Description copied from interface: ICheckEventCapability
Adds a listener to the component for the checked event

Specified by:
addCheckListener in interface ICheckEventCapability
Parameters:
listener - the listener to add

removeCheckListener

public final void removeCheckListener(ICheckListener listener)
Description copied from interface: ICheckEventCapability
Removes a listener from the list of listeners

Specified by:
removeCheckListener in interface ICheckEventCapability
Parameters:
listener - the listener to remove

listCheckListeners

public final FacesListener[] listCheckListeners()
Description copied from interface: ICheckEventCapability
Returns the list of check listener for the component

Specified by:
listCheckListeners in interface ICheckEventCapability
Returns:
check listeners' list

getCheckedValues

public Object getCheckedValues()
Specified by:
getCheckedValues in interface ICheckProvider

isCheckedValuesSetted

public final boolean isCheckedValuesSetted()
Returns true if the attribute "checkedValues" is set.

Returns:
true if the attribute is set.

getCheckedValuesType

public Class getCheckedValuesType(FacesContext facesContext)
Return the type of the property represented by the ValueExpression, relative to the specified FacesContext.

Specified by:
getCheckedValuesType in interface ICheckedValuesCapability

getFirstCheckedValue

public Object getFirstCheckedValue()
Specified by:
getFirstCheckedValue in interface ICheckProvider

getCheckedValuesCount

public int getCheckedValuesCount()
Specified by:
getCheckedValuesCount in interface ICheckProvider

listCheckedValues

public Object[] listCheckedValues()
Specified by:
listCheckedValues in interface ICheckProvider

getClientCheckFullState

public int getClientCheckFullState()
Description copied from interface: IClientCheckFullStateCapability
Returns an integer value indicating wether the client should know about the component's full state even if only a part of the data is present (AJAX).

Specified by:
getClientCheckFullState in interface IClientCheckFullStateCapability
Returns:
An integer value indicating wether the client should know about the component's full state.
See Also:
IClientFullStateCapability.NONE_CLIENT_FULL_STATE, IClientFullStateCapability.ONEWAY_CLIENT_FULL_STATE, IClientFullStateCapability.TWOWAYS_CLIENT_FULL_STATE

getClientCheckFullState

public int getClientCheckFullState(FacesContext facesContext)
See getClientCheckFullState() for more details


isClientCheckFullStateSetted

public final boolean isClientCheckFullStateSetted()
Returns true if the attribute "clientCheckFullState" is set.

Returns:
true if the attribute is set.

setClientCheckFullState

public void setClientCheckFullState(int clientCheckFullState)
Description copied from interface: IClientCheckFullStateCapability
Sets a boolean value indicating wether the client should know about the component's full state even if only a part of the data is present (AJAX).

Specified by:
setClientCheckFullState in interface IClientCheckFullStateCapability
See Also:
IClientFullStateCapability.NONE_CLIENT_FULL_STATE, IClientFullStateCapability.ONEWAY_CLIENT_FULL_STATE, IClientFullStateCapability.TWOWAYS_CLIENT_FULL_STATE

isSelectable

public boolean isSelectable()
Description copied from interface: ISelectableCapability
Returns a boolean value indicating wether the component can receive a user's selection

Specified by:
isSelectable in interface ISelectableCapability
Returns:
selectable boolean property

isSelectable

public boolean isSelectable(FacesContext facesContext)
See isSelectable() for more details


isSelectableSetted

public final boolean isSelectableSetted()
Returns true if the attribute "selectable" is set.

Returns:
true if the attribute is set.

setSelectable

public void setSelectable(boolean selectable)
Description copied from interface: ISelectableCapability
Sets a boolean value indicating wether the component can receive a user's selection

Specified by:
setSelectable in interface ISelectableCapability
Parameters:
selectable - selectable boolean property

getSelectionCardinality

public int getSelectionCardinality()
Description copied from interface: ISelectionCardinalityCapability
Returns an int value specifying the type of multiple selection authorized. cf. ICardinality for constant values

Specified by:
getSelectionCardinality in interface ISelectionCardinalityCapability
Returns:
1: none or one selection|2: any number of selections or none|3: one and only one selection|4: one or more selection

getSelectionCardinality

public int getSelectionCardinality(FacesContext facesContext)
See getSelectionCardinality() for more details


isSelectionCardinalitySetted

public final boolean isSelectionCardinalitySetted()
Returns true if the attribute "selectionCardinality" is set.

Returns:
true if the attribute is set.

setSelectionCardinality

public void setSelectionCardinality(int selectionCardinality)
Description copied from interface: ISelectionCardinalityCapability
Sets an int value specifying the type of multiple selection authorized. cf. ICardinality for constant values

Specified by:
setSelectionCardinality in interface ISelectionCardinalityCapability
Parameters:
selectionCardinality - 1: none or one selection|2: any number of selections or none|3: one and only one selection|4: one or more selection

addSelectionListener

public final void addSelectionListener(ISelectionListener listener)
Description copied from interface: ISelectionEventCapability
Adds a listener to the component for the selection event

Specified by:
addSelectionListener in interface ISelectionEventCapability
Parameters:
listener - the selection listener to add

removeSelectionListener

public final void removeSelectionListener(ISelectionListener listener)
Description copied from interface: ISelectionEventCapability
Removes a listener from the component for the selection event

Specified by:
removeSelectionListener in interface ISelectionEventCapability
Parameters:
listener - the selection listener to remove

listSelectionListeners

public final FacesListener[] listSelectionListeners()
Description copied from interface: ISelectionEventCapability
Returns a list of selection listener for the component

Specified by:
listSelectionListeners in interface ISelectionEventCapability
Returns:
selection listeners' list

getSelectedValues

public Object getSelectedValues()
Specified by:
getSelectedValues in interface ISelectionProvider

isSelectedValuesSetted

public final boolean isSelectedValuesSetted()
Returns true if the attribute "selectedValues" is set.

Returns:
true if the attribute is set.

getSelectedValuesType

public Class getSelectedValuesType(FacesContext facesContext)
Return the type of the property represented by the ValueExpression, relative to the specified FacesContext.

Specified by:
getSelectedValuesType in interface ISelectedValuesCapability

getFirstSelectedValue

public Object getFirstSelectedValue()
Specified by:
getFirstSelectedValue in interface ISelectionProvider

getSelectedValuesCount

public int getSelectedValuesCount()
Specified by:
getSelectedValuesCount in interface ISelectionProvider

listSelectedValues

public Object[] listSelectedValues()
Specified by:
listSelectedValues in interface ISelectionProvider

getClientSelectionFullState

public int getClientSelectionFullState()
Description copied from interface: IClientSelectionFullStateCapability
Returns a boolean value indicating whether the client should know about the component's full state even if only a part of the data is present (AJAX).

Specified by:
getClientSelectionFullState in interface IClientSelectionFullStateCapability
Returns:
boolean

getClientSelectionFullState

public int getClientSelectionFullState(FacesContext facesContext)
See getClientSelectionFullState() for more details


isClientSelectionFullStateSetted

public final boolean isClientSelectionFullStateSetted()
Returns true if the attribute "clientSelectionFullState" is set.

Returns:
true if the attribute is set.

setClientSelectionFullState

public void setClientSelectionFullState(int clientSelectionFullState)
Description copied from interface: IClientSelectionFullStateCapability
Sets a boolean value indicating whether the client should know about the component's full state even if only a part of the data is present (AJAX).

Specified by:
setClientSelectionFullState in interface IClientSelectionFullStateCapability
Parameters:
clientSelectionFullState - boolean

getPreloadedLevelDepth

public int getPreloadedLevelDepth()
Specified by:
getPreloadedLevelDepth in interface IPreloadedLevelDepthCapability

getPreloadedLevelDepth

public int getPreloadedLevelDepth(FacesContext facesContext)
See getPreloadedLevelDepth() for more details


isPreloadedLevelDepthSetted

public final boolean isPreloadedLevelDepthSetted()
Returns true if the attribute "preloadedLevelDepth" is set.

Returns:
true if the attribute is set.

setPreloadedLevelDepth

public void setPreloadedLevelDepth(int preloadedLevelDepth)
Specified by:
setPreloadedLevelDepth in interface IPreloadedLevelDepthCapability

isExpandable

public boolean isExpandable()
Description copied from interface: IExpandableCapability
Returns a boolean value indicating wether the component can receive a user's expand command.

Specified by:
isExpandable in interface IExpandableCapability
Returns:
expandable boolean property

isExpandable

public boolean isExpandable(FacesContext facesContext)
See isExpandable() for more details


isExpandableSetted

public final boolean isExpandableSetted()
Returns true if the attribute "expandable" is set.

Returns:
true if the attribute is set.

setExpandable

public void setExpandable(boolean expandable)
Description copied from interface: IExpandableCapability
Sets a boolean value indicating wether the component can receive a user's expand command.

Specified by:
setExpandable in interface IExpandableCapability
Parameters:
expandable - expandable boolean property

getExpandedValues

public Object getExpandedValues()
Specified by:
getExpandedValues in interface IExpansionProvider

isExpandedValuesSetted

public final boolean isExpandedValuesSetted()
Returns true if the attribute "expandedValues" is set.

Returns:
true if the attribute is set.

getExpandedValuesType

public Class getExpandedValuesType(FacesContext facesContext)
Return the type of the property represented by the ValueExpression, relative to the specified FacesContext.

Specified by:
getExpandedValuesType in interface IExpandedValuesCapability

listExpandedValues

public Object[] listExpandedValues()
Specified by:
listExpandedValues in interface IExpansionProvider

getExpandedValuesCount

public int getExpandedValuesCount()
Specified by:
getExpandedValuesCount in interface IExpansionProvider

getDefaultImageURL

public String getDefaultImageURL()
Returns an url string pointing to the default image.

Returns:
image url

getDefaultImageURL

public String getDefaultImageURL(FacesContext facesContext)
Returns an url string pointing to the default image.

Returns:
image url

setDefaultImageURL

public void setDefaultImageURL(String defaultImageURL)
Sets an url string pointing to the default image.

Parameters:
defaultImageURL - image url

isDefaultImageURLSetted

public boolean isDefaultImageURLSetted()
Returns true if the attribute "defaultImageURL" is set.

Returns:
true if the attribute is set.

getDefaultSelectedImageURL

public String getDefaultSelectedImageURL()
Returns an url string pointing to the default image for the selected state.

Returns:
selected image url

getDefaultSelectedImageURL

public String getDefaultSelectedImageURL(FacesContext facesContext)
Returns an url string pointing to the default image for the selected state.

Returns:
selected image url

setDefaultSelectedImageURL

public void setDefaultSelectedImageURL(String defaultSelectedImageURL)
Sets an url string pointing to the default image for the selected state.

Parameters:
defaultSelectedImageURL - selected image url

isDefaultSelectedImageURLSetted

public boolean isDefaultSelectedImageURLSetted()
Returns true if the attribute "defaultSelectedImageURL" is set.

Returns:
true if the attribute is set.

getDefaultExpandedImageURL

public String getDefaultExpandedImageURL()
Returns an url string pointing to the default image for an expanded node.

Returns:
expanded image url

getDefaultExpandedImageURL

public String getDefaultExpandedImageURL(FacesContext facesContext)
Returns an url string pointing to the default image for an expanded node.

Returns:
expanded image url

setDefaultExpandedImageURL

public void setDefaultExpandedImageURL(String defaultExpandedImageURL)
Sets an url string pointing to the default image for an expanded node.

Parameters:
defaultExpandedImageURL - expanded image url

isDefaultExpandedImageURLSetted

public boolean isDefaultExpandedImageURLSetted()
Returns true if the attribute "defaultExpandedImageURL" is set.

Returns:
true if the attribute is set.

getDefaultCollapsedImageURL

public String getDefaultCollapsedImageURL()

getDefaultCollapsedImageURL

public String getDefaultCollapsedImageURL(FacesContext facesContext)

setDefaultCollapsedImageURL

public void setDefaultCollapsedImageURL(String defaultCollapsedImageURL)

isDefaultCollapsedImageURLSetted

public boolean isDefaultCollapsedImageURLSetted()
Returns true if the attribute "defaultCollapsedImageURL" is set.

Returns:
true if the attribute is set.

getDefaultDisabledImageURL

public String getDefaultDisabledImageURL()
Returns an url string pointing to the default image for the disabled state.

Returns:
disabled image url

getDefaultDisabledImageURL

public String getDefaultDisabledImageURL(FacesContext facesContext)
Returns an url string pointing to the default image for the disabled state.

Returns:
disabled image url

setDefaultDisabledImageURL

public void setDefaultDisabledImageURL(String defaultDisabledImageURL)
Sets an url string pointing to the default image for the disabled state.

Parameters:
defaultDisabledImageURL - disabled image url

isDefaultDisabledImageURLSetted

public boolean isDefaultDisabledImageURLSetted()
Returns true if the attribute "defaultDisabledImageURL" is set.

Returns:
true if the attribute is set.

getDefaultLeafImageURL

public String getDefaultLeafImageURL()
Returns an url string pointing to the default image for a leaf.

Returns:
leaf image url

getDefaultLeafImageURL

public String getDefaultLeafImageURL(FacesContext facesContext)
Returns an url string pointing to the default image for a leaf.

Returns:
leaf image url

setDefaultLeafImageURL

public void setDefaultLeafImageURL(String defaultLeafImageURL)
Sets an url string pointing to the default image for a leaf.

Parameters:
defaultLeafImageURL - leaf image url

isDefaultLeafImageURLSetted

public boolean isDefaultLeafImageURLSetted()
Returns true if the attribute "defaultLeafImageURL" is set.

Returns:
true if the attribute is set.

getDefaultSelectedLeafImageURL

public String getDefaultSelectedLeafImageURL()

getDefaultSelectedLeafImageURL

public String getDefaultSelectedLeafImageURL(FacesContext facesContext)

setDefaultSelectedLeafImageURL

public void setDefaultSelectedLeafImageURL(String defaultSelectedLeafImageURL)

isDefaultSelectedLeafImageURLSetted

public boolean isDefaultSelectedLeafImageURLSetted()
Returns true if the attribute "defaultSelectedLeafImageURL" is set.

Returns:
true if the attribute is set.

getDefaultExpandedLeafImageURL

public String getDefaultExpandedLeafImageURL()

getDefaultExpandedLeafImageURL

public String getDefaultExpandedLeafImageURL(FacesContext facesContext)

setDefaultExpandedLeafImageURL

public void setDefaultExpandedLeafImageURL(String defaultExpandedLeafImageURL)

isDefaultExpandedLeafImageURLSetted

public boolean isDefaultExpandedLeafImageURLSetted()
Returns true if the attribute "defaultExpandedLeafImageURL" is set.

Returns:
true if the attribute is set.

getDefaultDisabledLeafImageURL

public String getDefaultDisabledLeafImageURL()

getDefaultDisabledLeafImageURL

public String getDefaultDisabledLeafImageURL(FacesContext facesContext)

setDefaultDisabledLeafImageURL

public void setDefaultDisabledLeafImageURL(String defaultDisabledLeafImageURL)

isDefaultDisabledLeafImageURLSetted

public boolean isDefaultDisabledLeafImageURLSetted()
Returns true if the attribute "defaultDisabledLeafImageURL" is set.

Returns:
true if the attribute is set.

isHideRootExpandSign

public boolean isHideRootExpandSign()
Returns a boolean value indicating wether the expand sign should be visible for the topmost node.

Returns:
true if the head node's expand sign is hidden

isHideRootExpandSign

public boolean isHideRootExpandSign(FacesContext facesContext)
Returns a boolean value indicating wether the expand sign should be visible for the topmost node.

Returns:
true if the head node's expand sign is hidden

setHideRootExpandSign

public void setHideRootExpandSign(boolean hideRootExpandSign)
Sets a boolean value indicating wether the expand sign should be visible for the topmost node.

Parameters:
hideRootExpandSign - true if the head node's expand sign is to be hidden

isHideRootExpandSignSetted

public boolean isHideRootExpandSignSetted()
Returns true if the attribute "hideRootExpandSign" is set.

Returns:
true if the attribute is set.

isBodyDroppable

public boolean isBodyDroppable()

isBodyDroppable

public boolean isBodyDroppable(FacesContext facesContext)

setBodyDroppable

public void setBodyDroppable(boolean bodyDroppable)

isBodyDroppableSetted

public boolean isBodyDroppableSetted()
Returns true if the attribute "bodyDroppable" is set.

Returns:
true if the attribute is set.

getCursorValue

public Object getCursorValue()

setCursorValue

public void setCursorValue(Object cursorValue)

isCursorValueSetted

public boolean isCursorValueSetted()
Returns true if the attribute "cursorValue" is set.

Returns:
true if the attribute is set.

isExpansionUseValue

public boolean isExpansionUseValue()
Returns a boolean value that indicates wether a node is identified by it's value or by a complete path.

Returns:
true if node identification use node value

isExpansionUseValue

public boolean isExpansionUseValue(FacesContext facesContext)
Returns a boolean value that indicates wether a node is identified by it's value or by a complete path.

Returns:
true if node identification use node value

setExpansionUseValue

public void setExpansionUseValue(boolean expansionUseValue)
Sets a boolean value that indicates wether a node is identified by it's value or by a complete path.

Parameters:
expansionUseValue - true if node identification should use node value

isExpansionUseValueSetted

public boolean isExpansionUseValueSetted()
Returns true if the attribute "expansionUseValue" is set.

Returns:
true if the attribute is set.

getCameliaFields

protected Set getCameliaFields()
Overrides:
getCameliaFields in class AbstractInputComponent

getCameliaValueAlias

protected String getCameliaValueAlias()
Overrides:
getCameliaValueAlias in class org.rcfaces.core.internal.component.CameliaInputComponent


Copyright © 2006-2011 Vedana. All Rights Reserved.