org.rcfaces.core.component
Class ViewDialogComponent

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UIOutput
              extended by org.rcfaces.core.internal.component.CameliaOutputComponent
                  extended by org.rcfaces.core.component.ViewDialogComponent
All Implemented Interfaces:
StateHolder, ValueHolder, IClosableCapability, ICloseEventCapability, IDialogPriorityCapability, IHeightCapability, IHiddenModeCapability, IImageCapability, IImmediateCapability, ILookAndFeelCapability, ISizeCapability, IStyleClassCapability, ITextCapability, ITextDirectionCapability, IVisibilityCapability, IWAIRoleCapability, IWidthCapability, org.rcfaces.core.internal.capability.IComponentLifeCycle, org.rcfaces.core.internal.capability.IConvertValueHolder, org.rcfaces.core.internal.capability.IImageAccessorsCapability, org.rcfaces.core.internal.capability.IRCFacesComponent, org.rcfaces.core.internal.manager.IContainerManager, org.rcfaces.core.internal.manager.ITransientAttributesManager

public class ViewDialogComponent
extends org.rcfaces.core.internal.component.CameliaOutputComponent
implements IImageCapability, IStyleClassCapability, ITextCapability, ITextDirectionCapability, IVisibilityCapability, IDialogPriorityCapability, ISizeCapability, IHiddenModeCapability, ILookAndFeelCapability, IWAIRoleCapability, ICloseEventCapability, IClosableCapability, IImmediateCapability, org.rcfaces.core.internal.capability.IImageAccessorsCapability

The viewDialog component represents popup modal view. It is based on the standard HTML tag <IFrame>.

The viewDialog Component has the following capabilities :

The default viewDialog renderer is linked to the f_viewDialog javascript class. f_viewDialog extends f_dialog, fa_immediate

Table of component style classes:

Style Name Description
f_viewDialog Defines styles for the wrapper FRAME element


Field Summary
protected static Set CAMELIA_ATTRIBUTES
           
static String COMPONENT_TYPE
           
 
Fields inherited from class org.rcfaces.core.internal.component.CameliaOutputComponent
engine
 
Fields inherited from class javax.faces.component.UIOutput
COMPONENT_FAMILY
 
Fields inherited from class javax.faces.component.UIComponent
bindings
 
Fields inherited from interface org.rcfaces.core.component.capability.ITextDirectionCapability
DEFAULT_TEXT_DIRECTION, LEFT_TO_RIGHT_TEXT_DIRECTION, RIGHT_LEFT_TEXT_DIRECTION
 
Fields inherited from interface org.rcfaces.core.component.capability.IDialogPriorityCapability
MAX_PRIORITY
 
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
ViewDialogComponent()
           
ViewDialogComponent(String componentId)
           
 
Method Summary
 void addCloseListener(ICloseListener listener)
          Adds a listener to the component for the close event
 String getAriaLabel()
           
 String getAriaLabel(FacesContext facesContext)
          See getAriaLabel() for more details
 int getAriaLevel()
           
 int getAriaLevel(FacesContext facesContext)
          See getAriaLevel() for more details
protected  Set getCameliaFields()
           
 int getDialogPriority()
           
 int getDialogPriority(FacesContext facesContext)
          See getDialogPriority() for more details
 String getHeight()
          Returns a string value (as specified by CSS) for the height of the component.
 String getHeight(FacesContext facesContext)
          See getHeight() for more details
 int getHiddenMode()
          Returns the hidden mode in client side.
 int getHiddenMode(FacesContext facesContext)
          See getHiddenMode() for more details
 IContentAccessors getImageAccessors()
          Returns ImageAccessors associated to the url.
 IContentAccessors getImageAccessors(FacesContext facesContext)
           
 String getImageURL()
          Returns the URL of the image.
 String getImageURL(FacesContext facesContext)
          See getImageURL() 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 getShellDecoratorName()
           
 String getShellDecoratorName(FacesContext facesContext)
           
 String getStyleClass()
          Returns the style class of the component.
 String getStyleClass(FacesContext facesContext)
          See getStyleClass() for more details
 String getText()
          Returns a string value specifying the text shown.
 String getText(FacesContext facesContext)
          See getText() for more details
 int getTextDirection()
           
 int getTextDirection(FacesContext facesContext)
          See getTextDirection() for more details
 String getViewURL()
           
 String getViewURL(FacesContext facesContext)
           
 Boolean getVisibleState()
          Returns TRUE if the receiver is visible, FALSE if the receiver is specified "not visible", and null otherwise.
 Boolean getVisibleState(FacesContext facesContext)
           
 String getWaiRole()
           
 String getWaiRole(FacesContext facesContext)
          See getWaiRole() for more details
 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 isAriaLabelSetted()
          Returns true if the attribute "ariaLabel" is set.
 boolean isAriaLevelSetted()
          Returns true if the attribute "ariaLevel" is set.
 boolean isClosable()
          Experimental : Do not use !
 boolean isClosable(FacesContext facesContext)
          See isClosable() for more details
 boolean isClosableSetted()
          Returns true if the attribute "closable" is set.
 boolean isDialogPrioritySetted()
          Returns true if the attribute "dialogPriority" is set.
 boolean isHeightSetted()
          Returns true if the attribute "height" is set.
 boolean isHiddenModeSetted()
          Returns true if the attribute "hiddenMode" is set.
 boolean isImageURLSetted()
          Returns true if the attribute "imageURL" 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 isLookIdSetted()
          Returns true if the attribute "lookId" is set.
 boolean isShellDecoratorNameSetted()
          Returns true if the attribute "shellDecoratorName" is set.
 boolean isStyleClassSetted()
          Returns true if the attribute "styleClass" is set.
 boolean isTextDirectionSetted()
          Returns true if the attribute "textDirection" is set.
 boolean isTextSetted()
          Returns true if the attribute "text" is set.
 boolean isViewURLSetted()
          Returns true if the attribute "viewURL" is set.
 boolean isVisible()
           
 boolean isVisible(FacesContext facesContext)
          See isVisible() for more details
 boolean isVisibleSetted()
          Returns true if the attribute "visible" is set.
 boolean isWaiRoleSetted()
          Returns true if the attribute "waiRole" is set.
 boolean isWidthSetted()
          Returns true if the attribute "width" is set.
 FacesListener[] listCloseListeners()
          Returns a list of close listener for the component
 void removeCloseListener(ICloseListener listener)
          Removes a listener from the component for the close event
 void setAriaLabel(String ariaLabel)
           
 void setAriaLevel(int ariaLevel)
           
 void setClosable(boolean closable)
          Experimental : Do not use !
 void setDialogPriority(int dialogPriority)
           
 void setHeight(String height)
          Sets a string value (as specified by CSS) for the height of the component.
 void setHiddenMode(int hiddenMode)
          Set the hidden mode in client side.
 void setHiddenMode(String hiddenMode)
           
 void setImageURL(String imageURL)
          Specify the URL of the image.
 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 setLookId(String lookId)
          Sets a string value specifying the choosen look of the component.
 void setShellDecoratorName(String shellDecoratorName)
           
 void setStyleClass(String styleClass)
          Specify the style class of the component.
 void setText(String text)
          Sets a string value specifying the text to be shown.
 void setTextDirection(int textDirection)
           
 void setViewURL(String viewURL)
           
 void setVisible(boolean visible)
          Marks the receiver as visible if the argument is TRUE, and marks it invisible if argument is FALSE.
 void setWaiRole(String waiRole)
           
 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.internal.component.CameliaOutputComponent
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, setConverter, setConverter, setDefaultProperties, setRendered, setTransientAttribute, setValueExpression, toString, updatePhase, validationPhase, verifyAsyncDecode
 
Methods inherited from class javax.faces.component.UIOutput
getConverter, getLocalValue, getValue, setConverter, 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
 
Methods inherited from interface javax.faces.component.ValueHolder
getConverter, getLocalValue, getValue, 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
Constructor Detail

ViewDialogComponent

public ViewDialogComponent()

ViewDialogComponent

public ViewDialogComponent(String componentId)
Method Detail

getImageAccessors

public IContentAccessors getImageAccessors(FacesContext facesContext)
Specified by:
getImageAccessors in interface org.rcfaces.core.internal.capability.IImageAccessorsCapability

setHiddenMode

public void setHiddenMode(String hiddenMode)

getVisibleState

public Boolean getVisibleState(FacesContext facesContext)

getImageURL

public String getImageURL()
Description copied from interface: IImageCapability
Returns the URL of the image.

Specified by:
getImageURL in interface IImageCapability

getImageURL

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


isImageURLSetted

public final boolean isImageURLSetted()
Returns true if the attribute "imageURL" is set.

Returns:
true if the attribute is set.

setImageURL

public void setImageURL(String imageURL)
Description copied from interface: IImageCapability
Specify the URL of the image.

Specified by:
setImageURL in interface IImageCapability

getImageAccessors

public IContentAccessors getImageAccessors()
Description copied from interface: IImageCapability
Returns ImageAccessors associated to the url. (or java.awt.Image binding)

Specified by:
getImageAccessors in interface IImageCapability
Returns:
IImageAccessors object.

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

getText

public String getText()
Description copied from interface: ITextCapability
Returns a string value specifying the text shown.

Specified by:
getText in interface ITextCapability
Returns:
text

getText

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


isTextSetted

public final boolean isTextSetted()
Returns true if the attribute "text" is set.

Returns:
true if the attribute is set.

setText

public void setText(String text)
Description copied from interface: ITextCapability
Sets a string value specifying the text to be shown.

Specified by:
setText in interface ITextCapability
Parameters:
text - text

getTextDirection

public int getTextDirection()
Specified by:
getTextDirection in interface ITextDirectionCapability

getTextDirection

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


isTextDirectionSetted

public final boolean isTextDirectionSetted()
Returns true if the attribute "textDirection" is set.

Returns:
true if the attribute is set.

setTextDirection

public void setTextDirection(int textDirection)
Specified by:
setTextDirection in interface ITextDirectionCapability

isVisible

public boolean isVisible()
Specified by:
isVisible in interface IVisibilityCapability

isVisible

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


isVisibleSetted

public final boolean isVisibleSetted()
Returns true if the attribute "visible" is set.

Returns:
true if the attribute is set.

setVisible

public void setVisible(boolean visible)
Description copied from interface: IVisibilityCapability
Marks the receiver as visible if the argument is TRUE, and marks it invisible if argument is FALSE.
If one of the receiver's ancestors is not visible or some other condition makes the receiver not visible, marking it visible may not actually cause it to be displayed.

Specified by:
setVisible in interface IVisibilityCapability
Parameters:
visible - the new visibility state.

getVisibleState

public Boolean getVisibleState()
Description copied from interface: IVisibilityCapability
Returns TRUE if the receiver is visible, FALSE if the receiver is specified "not visible", and null otherwise.
If one of the receiver's ancestors is not visible or some other condition makes the receiver not visible, this method may still indicate that it is considered visible even though it may not actually be showing.

Specified by:
getVisibleState in interface IVisibilityCapability
Returns:
the receiver's visibility state

getDialogPriority

public int getDialogPriority()
Specified by:
getDialogPriority in interface IDialogPriorityCapability

getDialogPriority

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


isDialogPrioritySetted

public final boolean isDialogPrioritySetted()
Returns true if the attribute "dialogPriority" is set.

Returns:
true if the attribute is set.

setDialogPriority

public void setDialogPriority(int dialogPriority)
Specified by:
setDialogPriority in interface IDialogPriorityCapability

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

getHeight

public String getHeight()
Description copied from interface: IHeightCapability
Returns a string value (as specified by CSS) for the height of the component.

Specified by:
getHeight in interface IHeightCapability
Returns:
height

getHeight

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


isHeightSetted

public final boolean isHeightSetted()
Returns true if the attribute "height" is set.

Returns:
true if the attribute is set.

setHeight

public void setHeight(String height)
Description copied from interface: IHeightCapability
Sets a string value (as specified by CSS) for the height of the component.

Specified by:
setHeight in interface IHeightCapability
Parameters:
height - height

getHiddenMode

public int getHiddenMode()
Description copied from interface: IHiddenModeCapability
Returns the hidden mode in client side.

Specified by:
getHiddenMode in interface IHiddenModeCapability
Returns:
hidden mode

getHiddenMode

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


isHiddenModeSetted

public final boolean isHiddenModeSetted()
Returns true if the attribute "hiddenMode" is set.

Returns:
true if the attribute is set.

setHiddenMode

public void setHiddenMode(int hiddenMode)
Description copied from interface: IHiddenModeCapability
Set the hidden mode in client side.

Specified by:
setHiddenMode in interface IHiddenModeCapability
Parameters:
hiddenMode - hidden mode

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

getAriaLabel

public String getAriaLabel()
Specified by:
getAriaLabel in interface IWAIRoleCapability

getAriaLabel

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


isAriaLabelSetted

public final boolean isAriaLabelSetted()
Returns true if the attribute "ariaLabel" is set.

Returns:
true if the attribute is set.

setAriaLabel

public void setAriaLabel(String ariaLabel)
Specified by:
setAriaLabel in interface IWAIRoleCapability

getAriaLevel

public int getAriaLevel()
Specified by:
getAriaLevel in interface IWAIRoleCapability

getAriaLevel

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


isAriaLevelSetted

public final boolean isAriaLevelSetted()
Returns true if the attribute "ariaLevel" is set.

Returns:
true if the attribute is set.

setAriaLevel

public void setAriaLevel(int ariaLevel)
Specified by:
setAriaLevel in interface IWAIRoleCapability

getWaiRole

public String getWaiRole()
Specified by:
getWaiRole in interface IWAIRoleCapability

getWaiRole

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


isWaiRoleSetted

public final boolean isWaiRoleSetted()
Returns true if the attribute "waiRole" is set.

Returns:
true if the attribute is set.

setWaiRole

public void setWaiRole(String waiRole)
Specified by:
setWaiRole in interface IWAIRoleCapability

addCloseListener

public final void addCloseListener(ICloseListener listener)
Description copied from interface: ICloseEventCapability
Adds a listener to the component for the close event

Specified by:
addCloseListener in interface ICloseEventCapability
Parameters:
listener - the close listener to add

removeCloseListener

public final void removeCloseListener(ICloseListener listener)
Description copied from interface: ICloseEventCapability
Removes a listener from the component for the close event

Specified by:
removeCloseListener in interface ICloseEventCapability
Parameters:
listener - the close listener to remove

listCloseListeners

public final FacesListener[] listCloseListeners()
Description copied from interface: ICloseEventCapability
Returns a list of close listener for the component

Specified by:
listCloseListeners in interface ICloseEventCapability
Returns:
close listeners' list

isClosable

public boolean isClosable()
Description copied from interface: IClosableCapability
Experimental : Do not use !

Specified by:
isClosable in interface IClosableCapability
Returns:
true is the component can be closed.

isClosable

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


isClosableSetted

public final boolean isClosableSetted()
Returns true if the attribute "closable" is set.

Returns:
true if the attribute is set.

setClosable

public void setClosable(boolean closable)
Description copied from interface: IClosableCapability
Experimental : Do not use !

Specified by:
setClosable in interface IClosableCapability

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

getViewURL

public String getViewURL()

getViewURL

public String getViewURL(FacesContext facesContext)

setViewURL

public void setViewURL(String viewURL)

isViewURLSetted

public boolean isViewURLSetted()
Returns true if the attribute "viewURL" is set.

Returns:
true if the attribute is set.

getShellDecoratorName

public String getShellDecoratorName()

getShellDecoratorName

public String getShellDecoratorName(FacesContext facesContext)

setShellDecoratorName

public void setShellDecoratorName(String shellDecoratorName)

isShellDecoratorNameSetted

public boolean isShellDecoratorNameSetted()
Returns true if the attribute "shellDecoratorName" is set.

Returns:
true if the attribute is set.

getCameliaFields

protected Set getCameliaFields()
Overrides:
getCameliaFields in class org.rcfaces.core.internal.component.CameliaOutputComponent


Copyright © 2006-2011 Vedana. All Rights Reserved.