org.rcfaces.core.component
Class ToolItemComponent

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UISelectItem
              extended by org.rcfaces.core.internal.component.CameliaItemComponent
                  extended by org.rcfaces.core.component.AbstractItemComponent
                      extended by org.rcfaces.core.component.SelectItemComponent
                          extended by org.rcfaces.core.component.UIImageItemComponent
                              extended by org.rcfaces.core.component.ToolItemComponent
All Implemented Interfaces:
StateHolder, IAccessKeyCapability, IAlternateTextCapability, IBorderTypeCapability, IClientDataCapability, IDisabledCapability, IHorizontalTextPositionCapability, IImageCapability, IImageSizeCapability, IImmediateCapability, IInputTypeCapability, ILookAndFeelCapability, IRadioGroupCapability, IServerDataCapability, IStatesImageCapability, IStyleClassCapability, ITextPositionCapability, IToolTipCapability, IUnlockedClientAttributesCapability, IVisibilityCapability, IWidthCapability, org.rcfaces.core.internal.capability.IComponentLifeCycle, org.rcfaces.core.internal.capability.IImageAccessorsCapability, org.rcfaces.core.internal.capability.IRCFacesComponent, org.rcfaces.core.internal.manager.IClientDataManager, org.rcfaces.core.internal.manager.IContainerManager, org.rcfaces.core.internal.manager.IServerDataManager, org.rcfaces.core.internal.manager.ITransientAttributesManager

public class ToolItemComponent
extends UIImageItemComponent
implements IRadioGroupCapability, IInputTypeCapability, IImageSizeCapability, ILookAndFeelCapability, IBorderTypeCapability, ITextPositionCapability, IAccessKeyCapability, IWidthCapability, IStyleClassCapability, IImmediateCapability

EXPERIMENTAL


Field Summary
protected static Set CAMELIA_ATTRIBUTES
           
static String COMPONENT_TYPE
           
 
Fields inherited from class org.rcfaces.core.internal.component.CameliaItemComponent
engine
 
Fields inherited from class javax.faces.component.UISelectItem
COMPONENT_FAMILY
 
Fields inherited from class javax.faces.component.UIComponent
bindings
 
Fields inherited from interface org.rcfaces.core.component.capability.IInputTypeCapability
AS_CHECK_BUTTON, AS_DROP_DOWN_MENU, AS_PUSH_BUTTON, AS_RADIO_BUTTON, AS_RESET_BUTTON, AS_SEPARATOR, AS_SUBMIT_BUTTON
 
Fields inherited from interface org.rcfaces.core.component.capability.IBorderTypeCapability
NONE_BORDER_TYPE_NAME
 
Fields inherited from interface org.rcfaces.core.component.capability.ITextPositionCapability
BOTTOM_POSITION, TOP_POSITION
 
Fields inherited from interface org.rcfaces.core.component.capability.IHorizontalTextPositionCapability
CENTER_POSITION, DEFAULT_POSITION, LEFT_POSITION, RIGHT_POSITION, UNKNOWN_POSITION
 
Constructor Summary
ToolItemComponent()
           
ToolItemComponent(String componentId)
           
 
Method Summary
 String getAccessKey()
          Returns a string that indicates the alphanumeric key used to execute an action from the keyboard (in conjunction with a alteration key ex : Alt).
 String getAccessKey(FacesContext facesContext)
          See getAccessKey() for more details
 String getBorderType()
          Returns a string that indicates the type of border the component should show.
 String getBorderType(FacesContext facesContext)
          See getBorderType() for more details
protected  Set getCameliaFields()
           
 String getGroupName()
          Returns a string specifying the name of the virtual entity that links different components together.
 String getGroupName(FacesContext facesContext)
          See getGroupName() for more details
 int getImageHeight()
          Returns an int value specifying the height (in pixels) to use for the image shown.
 int getImageHeight(FacesContext facesContext)
          See getImageHeight() for more details
 int getImageWidth()
          Returns an int value specifying the width (in pixels) to use for the image shown.
 int getImageWidth(FacesContext facesContext)
          See getImageWidth() for more details
 int getInputType()
           
 int getInputType(FacesContext facesContext)
          See getInputType() for more details
 String getLookId()
          Returns a string value specifying the choosen look of the component.
 String getLookId(FacesContext facesContext)
          See getLookId() for more details
 String getStyleClass()
          Returns the style class of the component.
 String getStyleClass(FacesContext facesContext)
          See getStyleClass() for more details
 int getTextPosition()
          Returns an int value specifying the position of the text in the component.
 int getTextPosition(FacesContext facesContext)
          See getTextPosition() for more details
protected  Converter getTextPositionConverter()
           
 ToolFolderComponent getToolFolder()
           
 String getWidth()
          Returns a string value (as specified by CSS) for the width of the component.
 String getWidth(FacesContext facesContext)
          See getWidth() for more details
 boolean isAccessKeySetted()
          Returns true if the attribute "accessKey" is set.
 boolean isBorderTypeSetted()
          Returns true if the attribute "borderType" is set.
 boolean isGroupNameSetted()
          Returns true if the attribute "groupName" is set.
 boolean isImageHeightSetted()
          Returns true if the attribute "imageHeight" is set.
 boolean isImageWidthSetted()
          Returns true if the attribute "imageWidth" is set.
 boolean isImmediate()
          Returns a boolean value indicating that this component's value must be converted and validated immediately (that is, during Apply Request Values phase), rather than waiting until Process Validations phase.
 boolean isImmediate(FacesContext facesContext)
          See isImmediate() for more details
 boolean isImmediateSetted()
          Returns true if the attribute "immediate" is set.
 boolean isInputTypeSetted()
          Returns true if the attribute "inputType" is set.
 boolean isLookIdSetted()
          Returns true if the attribute "lookId" is set.
 boolean isStyleClassSetted()
          Returns true if the attribute "styleClass" is set.
 boolean isTextPositionSetted()
          Returns true if the attribute "textPosition" is set.
 boolean isWidthSetted()
          Returns true if the attribute "width" is set.
 void setAccessKey(String accessKey)
          Sets a string that indicates the alphanumeric key used to execute an action from the keyboard (in conjunction with a alteration key ex : Alt).
 void setBorderType(String borderType)
          Sets a string that indicates the type of border the component should show.
 void setGroupName(String groupName)
          Sets a string specifying the name of the virtual entity that links different components together.
 void setImageHeight(int imageHeight)
          Sets an int value specifying the height (in pixels) to use for the image shown.
 void setImageWidth(int imageWidth)
          Sets an int value specifying the width (in pixels) to use for the image shown.
 void setImmediate(boolean immediate)
          Sets a boolean value indicating that this component's value must be converted and validated immediately (that is, during Apply Request Values phase), rather than waiting until Process Validations phase.
 void setInputType(int inputType)
           
 void setInputType(String inputType)
           
 void setLookId(String lookId)
          Sets a string value specifying the choosen look of the component.
 void setStyleClass(String styleClass)
          Specify the style class of the component.
 void setTextPosition(int textPosition)
          Sets an int value specifying the position of the text in the component.
 void setTextPosition(String textPosition)
           
 void setWidth(String width)
          Sets a string value (as specified by CSS) for the width of the component.
 
Methods inherited from class org.rcfaces.core.component.UIImageItemComponent
getAlternateText, getAlternateText, getDisabledImageURL, getDisabledImageURL, getHoverImageURL, getHoverImageURL, getImageAccessors, getImageAccessors, getImageURL, getImageURL, getSelectedImageURL, getSelectedImageURL, getVisibleState, getVisibleState, isAlternateTextSetted, isDisabledImageURLSetted, isHoverImageURLSetted, isImageURLSetted, isSelectedImageURLSetted, isVisible, isVisible, isVisibleSetted, setAlternateText, setDisabledImageURL, setHoverImageURL, setImageURL, setSelectedImageURL, setVisible
 
Methods inherited from class org.rcfaces.core.component.SelectItemComponent
getToolTip, getToolTipText, getToolTipText, isToolTipTextSetted, setToolTip, setToolTipText, setValueExpression
 
Methods inherited from class org.rcfaces.core.component.AbstractItemComponent
getClientData, getClientData, getClientDataCount, getClientDataMap, getClientDataMap, getServerData, getServerData, getServerDataCount, getServerDataMap, getServerDataMap, getUnlockedClientAttributeNames, getUnlockedClientAttributeNames, isDisabled, isDisabledSetted, isUnlockedClientAttributeNamesSetted, listClientDataKeys, listClientDataKeys, listServerDataKeys, listServerDataKeys, removeClientData, removeServerData, setClientData, setClientData, setDisabled, setServerData, setServerData, setUnlockedClientAttributeNames
 
Methods inherited from class org.rcfaces.core.internal.component.CameliaItemComponent
clearListeners, confirmListenerAppend, constructPhase, constructTemplate, decodePhase, encodeBegin, encodeChildren, encodeEnd, getAsyncRenderer, getCameliaValueAlias, getChildren, getChildrenListState, getFamily, getRendererType, getTransientAttribute, getValueExpression, hasDefaultProperties, initializeComponent, initializePhase, isClientRendered, isRendered, isTemplateComponent, processDecodes, processEngineUpdates, processEngineValidators, processUpdates, processValidators, queueEvent, renderPhase, restoreState, saveState, setDefaultProperties, setRendered, setTransientAttribute, toString, updatePhase, validationPhase, verifyAsyncDecode
 
Methods inherited from class javax.faces.component.UISelectItem
getItemDescription, getItemLabel, getItemValue, getValue, isItemDisabled, isItemEscaped, setItemDescription, setItemDisabled, setItemEscaped, setItemLabel, setItemValue, setValue
 
Methods inherited from class javax.faces.component.UIComponentBase
addFacesListener, broadcast, decode, 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.internal.manager.IContainerManager
getChildCount
 

Field Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE
See Also:
Constant Field Values

CAMELIA_ATTRIBUTES

protected static final Set CAMELIA_ATTRIBUTES
Constructor Detail

ToolItemComponent

public ToolItemComponent()

ToolItemComponent

public ToolItemComponent(String componentId)
Method Detail

setInputType

public void setInputType(String inputType)

getToolFolder

public ToolFolderComponent getToolFolder()

getTextPositionConverter

protected Converter getTextPositionConverter()

setTextPosition

public void setTextPosition(String textPosition)

getGroupName

public String getGroupName()
Description copied from interface: IRadioGroupCapability
Returns a string specifying the name of the virtual entity that links different components together.

Specified by:
getGroupName in interface IRadioGroupCapability
Returns:
group name

getGroupName

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


isGroupNameSetted

public final boolean isGroupNameSetted()
Returns true if the attribute "groupName" is set.

Returns:
true if the attribute is set.

setGroupName

public void setGroupName(String groupName)
Description copied from interface: IRadioGroupCapability
Sets a string specifying the name of the virtual entity that links different components together.

Specified by:
setGroupName in interface IRadioGroupCapability
Parameters:
groupName - group name

getInputType

public int getInputType()
Specified by:
getInputType in interface IInputTypeCapability

getInputType

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


isInputTypeSetted

public final boolean isInputTypeSetted()
Returns true if the attribute "inputType" is set.

Returns:
true if the attribute is set.

setInputType

public void setInputType(int inputType)
Specified by:
setInputType in interface IInputTypeCapability

getImageHeight

public int getImageHeight()
Description copied from interface: IImageSizeCapability
Returns an int value specifying the height (in pixels) to use for the image shown.

Specified by:
getImageHeight in interface IImageSizeCapability
Returns:
image height in pixels

getImageHeight

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


isImageHeightSetted

public final boolean isImageHeightSetted()
Returns true if the attribute "imageHeight" is set.

Returns:
true if the attribute is set.

setImageHeight

public void setImageHeight(int imageHeight)
Description copied from interface: IImageSizeCapability
Sets an int value specifying the height (in pixels) to use for the image shown.

Specified by:
setImageHeight in interface IImageSizeCapability
Parameters:
imageHeight - image height in pixels

getImageWidth

public int getImageWidth()
Description copied from interface: IImageSizeCapability
Returns an int value specifying the width (in pixels) to use for the image shown.

Specified by:
getImageWidth in interface IImageSizeCapability
Returns:
image width in pixels

getImageWidth

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


isImageWidthSetted

public final boolean isImageWidthSetted()
Returns true if the attribute "imageWidth" is set.

Returns:
true if the attribute is set.

setImageWidth

public void setImageWidth(int imageWidth)
Description copied from interface: IImageSizeCapability
Sets an int value specifying the width (in pixels) to use for the image shown.

Specified by:
setImageWidth in interface IImageSizeCapability
Parameters:
imageWidth - image width in pixels

getLookId

public String getLookId()
Description copied from interface: ILookAndFeelCapability
Returns a string value specifying the choosen look of the component.

Specified by:
getLookId in interface ILookAndFeelCapability
Returns:
lookId

getLookId

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


isLookIdSetted

public final boolean isLookIdSetted()
Returns true if the attribute "lookId" is set.

Returns:
true if the attribute is set.

setLookId

public void setLookId(String lookId)
Description copied from interface: ILookAndFeelCapability
Sets a string value specifying the choosen look of the component.

Specified by:
setLookId in interface ILookAndFeelCapability
Parameters:
lookId - lookId

getBorderType

public String getBorderType()
Description copied from interface: IBorderTypeCapability
Returns a string that indicates the type of border the component should show.

Specified by:
getBorderType in interface IBorderTypeCapability
Returns:
none|solid|relief|flat|rounded

getBorderType

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


isBorderTypeSetted

public final boolean isBorderTypeSetted()
Returns true if the attribute "borderType" is set.

Returns:
true if the attribute is set.

setBorderType

public void setBorderType(String borderType)
Description copied from interface: IBorderTypeCapability
Sets a string that indicates the type of border the component should show.

Specified by:
setBorderType in interface IBorderTypeCapability
Parameters:
borderType - none|solid|relief|flat|rounded

getTextPosition

public int getTextPosition()
Description copied from interface: IHorizontalTextPositionCapability
Returns an int value specifying the position of the text in the component.

Specified by:
getTextPosition in interface IHorizontalTextPositionCapability
Returns:
0x08:right|0x10:left

getTextPosition

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


isTextPositionSetted

public final boolean isTextPositionSetted()
Returns true if the attribute "textPosition" is set.

Returns:
true if the attribute is set.

setTextPosition

public void setTextPosition(int textPosition)
Description copied from interface: IHorizontalTextPositionCapability
Sets an int value specifying the position of the text in the component.

Specified by:
setTextPosition in interface IHorizontalTextPositionCapability
Parameters:
textPosition - 0x00:right|0x10:left

getAccessKey

public String getAccessKey()
Description copied from interface: IAccessKeyCapability
Returns a string that indicates the alphanumeric key used to execute an action from the keyboard (in conjunction with a alteration key ex : Alt).

Specified by:
getAccessKey in interface IAccessKeyCapability
Returns:
<Any alphanumeric key>

getAccessKey

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


isAccessKeySetted

public final boolean isAccessKeySetted()
Returns true if the attribute "accessKey" is set.

Returns:
true if the attribute is set.

setAccessKey

public void setAccessKey(String accessKey)
Description copied from interface: IAccessKeyCapability
Sets a string that indicates the alphanumeric key used to execute an action from the keyboard (in conjunction with a alteration key ex : Alt).

Specified by:
setAccessKey in interface IAccessKeyCapability
Parameters:
accessKey - <Any alphanumeric key>

getWidth

public String getWidth()
Description copied from interface: IWidthCapability
Returns a string value (as specified by CSS) for the width of the component.

Specified by:
getWidth in interface IWidthCapability
Returns:
width

getWidth

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


isWidthSetted

public final boolean isWidthSetted()
Returns true if the attribute "width" is set.

Returns:
true if the attribute is set.

setWidth

public void setWidth(String width)
Description copied from interface: IWidthCapability
Sets a string value (as specified by CSS) for the width of the component.

Specified by:
setWidth in interface IWidthCapability
Parameters:
width - width

getStyleClass

public String getStyleClass()
Description copied from interface: IStyleClassCapability
Returns the style class of the component.

Specified by:
getStyleClass in interface IStyleClassCapability
Returns:
style class

getStyleClass

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


isStyleClassSetted

public final boolean isStyleClassSetted()
Returns true if the attribute "styleClass" is set.

Returns:
true if the attribute is set.

setStyleClass

public void setStyleClass(String styleClass)
Description copied from interface: IStyleClassCapability
Specify the style class of the component.

Specified by:
setStyleClass in interface IStyleClassCapability
Parameters:
styleClass - style class

isImmediate

public boolean isImmediate()
Description copied from interface: IImmediateCapability
Returns a boolean value indicating that this component's value must be converted and validated immediately (that is, during Apply Request Values phase), rather than waiting until Process Validations phase.

Specified by:
isImmediate in interface IImmediateCapability
Returns:
boolean

isImmediate

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


isImmediateSetted

public final boolean isImmediateSetted()
Returns true if the attribute "immediate" is set.

Returns:
true if the attribute is set.

setImmediate

public void setImmediate(boolean immediate)
Description copied from interface: IImmediateCapability
Sets a boolean value indicating that this component's value must be converted and validated immediately (that is, during Apply Request Values phase), rather than waiting until Process Validations phase.

Specified by:
setImmediate in interface IImmediateCapability
Parameters:
immediate - boolean

getCameliaFields

protected Set getCameliaFields()
Overrides:
getCameliaFields in class UIImageItemComponent


Copyright © 2006-2011 Vedana. All Rights Reserved.