oracle.adf.view.faces.component.core.nav
Class CoreCommandButton

java.lang.Object
  javax.faces.component.UIComponent
      oracle.adf.view.faces.component.UIXComponent
          oracle.adf.view.faces.component.UIXComponentBase
              oracle.adf.view.faces.component.UIXCommand
                  oracle.adf.view.faces.component.core.nav.CoreCommandButton

All Implemented Interfaces:

ActionSource, DialogSource, StateHolder

public class CoreCommandButton

extends UIXCommand

The commandButton control creates a button representation of a UIXCommand.

Example:

A simple example of a button saying "Enter" that submits an input field.

    <af:form>
      <af:inputText value="Default input text" />
      <af:commandButton text="Enter"/>
    </af:form>

An button which submits the form without doing any validation.

    <af:form>
      <af:inputText value="Default input text"/>
      <af:commandButton text="Unvalidated Submit"
                        immediate="true" />
    </form>

Events:

Type	Phases	Description
javax.faces.event.ActionEvent	Invoke Application Apply Request Values	Event delivered when the "action" of the component has been invoked; for example, by clicking on a button. The action may result in page navigation.
oracle.adf.view.faces.event.ReturnEvent	Apply Request Values	Event delivered when the dialog has completed successfully.
oracle.adf.view.faces.event.LaunchEvent	Invoke Application Apply Request Values	Event delivered to prompt the command to launch a dialog.

It does not support any children.

Field Summary

static PropertyKey	ACCESS_KEY_KEY
static PropertyKey	BLOCKING_KEY
static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static PropertyKey	DISABLED_KEY
static PropertyKey	INLINE_STYLE_KEY
static PropertyKey	ONCLICK_KEY
static PropertyKey	ONDBLCLICK_KEY
static PropertyKey	ONKEYDOWN_KEY
static PropertyKey	ONKEYPRESS_KEY
static PropertyKey	ONKEYUP_KEY
static PropertyKey	ONMOUSEDOWN_KEY
static PropertyKey	ONMOUSEMOVE_KEY
static PropertyKey	ONMOUSEOUT_KEY
static PropertyKey	ONMOUSEOVER_KEY
static PropertyKey	ONMOUSEUP_KEY
static PropertyKey	PARTIAL_SUBMIT_KEY
static PropertyKey	PARTIAL_TRIGGERS_KEY
static PropertyKey	SHORT_DESC_KEY
static PropertyKey	STYLE_CLASS_KEY
static PropertyKey	TEXT_KEY
static FacesBean.Type	TYPE
static PropertyKey	USE_WINDOW_KEY
static PropertyKey	WINDOW_HEIGHT_KEY
static PropertyKey	WINDOW_WIDTH_KEY

Fields inherited from class oracle.adf.view.faces.component.UIXCommand

ACTION_KEY, ACTION_LISTENER_KEY, IMMEDIATE_KEY, LAUNCH_LISTENER_KEY, RETURN_LISTENER_KEY

Fields inherited from class oracle.adf.view.faces.component.UIXComponentBase

BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY

Constructor Summary

	CoreCommandButton() Construct an instance of the CoreCommandButton.
protected	CoreCommandButton(java.lang.String rendererType) Construct an instance of the CoreCommandButton.

Method Summary

char	getAccessKey() Gets Character used to gain quick access to this button.
protected FacesBean.Type	getBeanType()
java.lang.String	getFamily()
java.lang.String	getInlineStyle() Gets the inline CSS style for this element
java.lang.String	getOnclick() Gets an onclick Javascript handler.
java.lang.String	getOndblclick() Gets an ondblclick Javascript handler.
java.lang.String	getOnkeydown() Gets an onkeydown Javascript handler.
java.lang.String	getOnkeypress() Gets an onkeypress Javascript handler.
java.lang.String	getOnkeyup() Gets an onkeyup Javascript handler.
java.lang.String	getOnmousedown() Gets an onmousedown Javascript handler.
java.lang.String	getOnmousemove() Gets an onmousemove Javascript handler.
java.lang.String	getOnmouseout() Gets an onmouseout Javascript handler.
java.lang.String	getOnmouseover() Gets an onmouseover Javascript handler.
java.lang.String	getOnmouseup() Gets an onmouseup Javascript handler.
java.lang.String[]	getPartialTriggers() Gets the IDs of the components that should trigger a partial update.
java.lang.String	getShortDesc() Gets the short description of the bean.
java.lang.String	getStyleClass() Gets the CSS style class of the bean.
java.lang.String	getText() Gets the textual label of the button.
int	getWindowHeight() Gets height of the window, if this command is used to launch a window.
int	getWindowWidth() Gets width of the window, if this command is used to launch a window.
boolean	isBlocking() Gets If set to TRUE the component will start blocking user input when the action is initiated.
boolean	isDisabled() Gets whether the button should be disabled.
boolean	isPartialSubmit() Gets whether the action should be done through a partial page submit or not.
boolean	isUseWindow() Gets whether to use a new window when launching dialogs.
void	setAccessKey(char accessKey) Sets Character used to gain quick access to this button.
void	setBlocking(boolean blocking) Sets If set to TRUE the component will start blocking user input when the action is initiated.
void	setDisabled(boolean disabled) Sets whether the button should be disabled.
void	setInlineStyle(java.lang.String inlineStyle) Sets the inline CSS style for this element
void	setOnclick(java.lang.String onclick) Sets an onclick Javascript handler.
void	setOndblclick(java.lang.String ondblclick) Sets an ondblclick Javascript handler.
void	setOnkeydown(java.lang.String onkeydown) Sets an onkeydown Javascript handler.
void	setOnkeypress(java.lang.String onkeypress) Sets an onkeypress Javascript handler.
void	setOnkeyup(java.lang.String onkeyup) Sets an onkeyup Javascript handler.
void	setOnmousedown(java.lang.String onmousedown) Sets an onmousedown Javascript handler.
void	setOnmousemove(java.lang.String onmousemove) Sets an onmousemove Javascript handler.
void	setOnmouseout(java.lang.String onmouseout) Sets an onmouseout Javascript handler.
void	setOnmouseover(java.lang.String onmouseover) Sets an onmouseover Javascript handler.
void	setOnmouseup(java.lang.String onmouseup) Sets an onmouseup Javascript handler.
void	setPartialSubmit(boolean partialSubmit) Sets whether the action should be done through a partial page submit or not.
void	setPartialTriggers(java.lang.String[] partialTriggers) Sets the IDs of the components that should trigger a partial update.
void	setShortDesc(java.lang.String shortDesc) Sets the short description of the bean.
void	setStyleClass(java.lang.String styleClass) Sets the CSS style class of the bean.
void	setText(java.lang.String text) Sets the textual label of the button.
void	setUseWindow(boolean useWindow) Sets whether to use a new window when launching dialogs.
void	setWindowHeight(int windowHeight) Sets height of the window, if this command is used to launch a window.
void	setWindowWidth(int windowWidth) Sets width of the window, if this command is used to launch a window.

Methods inherited from class oracle.adf.view.faces.component.UIXCommand

addActionListener, addLaunchListener, addReturnListener, broadcast, getAction, getActionListener, getActionListeners, getLaunchListener, getLaunchListeners, getReturnListener, getReturnListeners, isImmediate, queueEvent, removeActionListener, removeLaunchListener, removeReturnListener, setAction, setActionListener, setImmediate, setLaunchListener, setReturnListener

Methods inherited from class oracle.adf.view.faces.component.UIXComponentBase

addAttributeChange, addAttributeChange, addAttributeChangeListener, addFacesListener, createFacesBean, decode, decodeChildren, decodeChildrenImpl, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getLocalClientId, getParent, getProperty, getPropertyKey, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, removeAttributeChangeListener, removeFacesListener, restoreState, saveState, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, toString, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

TYPE

public static final FacesBean.Type TYPE

TEXT_KEY

public static final PropertyKey TEXT_KEY

DISABLED_KEY

public static final PropertyKey DISABLED_KEY

ACCESS_KEY_KEY

public static final PropertyKey ACCESS_KEY_KEY

PARTIAL_SUBMIT_KEY

public static final PropertyKey PARTIAL_SUBMIT_KEY

SHORT_DESC_KEY

public static final PropertyKey SHORT_DESC_KEY

PARTIAL_TRIGGERS_KEY

public static final PropertyKey PARTIAL_TRIGGERS_KEY

USE_WINDOW_KEY

public static final PropertyKey USE_WINDOW_KEY

WINDOW_WIDTH_KEY

public static final PropertyKey WINDOW_WIDTH_KEY

WINDOW_HEIGHT_KEY

public static final PropertyKey WINDOW_HEIGHT_KEY

ONCLICK_KEY

public static final PropertyKey ONCLICK_KEY

ONDBLCLICK_KEY

public static final PropertyKey ONDBLCLICK_KEY

ONMOUSEDOWN_KEY

public static final PropertyKey ONMOUSEDOWN_KEY

ONMOUSEUP_KEY

public static final PropertyKey ONMOUSEUP_KEY

ONMOUSEOVER_KEY

public static final PropertyKey ONMOUSEOVER_KEY

ONMOUSEMOVE_KEY

public static final PropertyKey ONMOUSEMOVE_KEY

ONMOUSEOUT_KEY

public static final PropertyKey ONMOUSEOUT_KEY

ONKEYPRESS_KEY

public static final PropertyKey ONKEYPRESS_KEY

ONKEYDOWN_KEY

public static final PropertyKey ONKEYDOWN_KEY

ONKEYUP_KEY

public static final PropertyKey ONKEYUP_KEY

STYLE_CLASS_KEY

public static final PropertyKey STYLE_CLASS_KEY

INLINE_STYLE_KEY

public static final PropertyKey INLINE_STYLE_KEY

BLOCKING_KEY

public static final PropertyKey BLOCKING_KEY

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY

See Also:

Constant Field Values

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

Constructor Detail

CoreCommandButton

public CoreCommandButton()

Construct an instance of the CoreCommandButton.

CoreCommandButton

protected CoreCommandButton(java.lang.String rendererType)

Construct an instance of the CoreCommandButton.

Method Detail

getText

public final java.lang.String getText()

Gets the textual label of the button.

setText

public final void setText(java.lang.String text)

Sets the textual label of the button.

isDisabled

public final boolean isDisabled()

Gets whether the button should be disabled.

setDisabled

public final void setDisabled(boolean disabled)

Sets whether the button should be disabled.

getAccessKey

public final char getAccessKey()

Gets Character used to gain quick access to this button. For accessibility reasons, this functionality is not supported in screen reader mode.

If the same access key appears in multiple input fields in the same page of output, the rendering user agent will cycle among the elements accessed by the similar keys. Note that user agents are inconsistent about dealing with two links having same access key, and so the cycling behavior is dependent on what the user agent provides.

This attribute is sometimes referred to as the "mnemonic".

The character specified by this attribute must exist in the Text attribute of this button instance. If it does not, the user will receive no visual indication of the existence of the accessKey. The easiest, and most convenient way to specify both the text and the mnemonic together is to use textAndAccessKey.

setAccessKey

public final void setAccessKey(char accessKey)

Sets Character used to gain quick access to this button. For accessibility reasons, this functionality is not supported in screen reader mode.

If the same access key appears in multiple input fields in the same page of output, the rendering user agent will cycle among the elements accessed by the similar keys. Note that user agents are inconsistent about dealing with two links having same access key, and so the cycling behavior is dependent on what the user agent provides.

This attribute is sometimes referred to as the "mnemonic".

The character specified by this attribute must exist in the Text attribute of this button instance. If it does not, the user will receive no visual indication of the existence of the accessKey. The easiest, and most convenient way to specify both the text and the mnemonic together is to use textAndAccessKey.

isPartialSubmit

public final boolean isPartialSubmit()

Gets whether the action should be done through a partial page submit or not. Default is false: no partial page submit.

setPartialSubmit

public final void setPartialSubmit(boolean partialSubmit)

Sets whether the action should be done through a partial page submit or not. Default is false: no partial page submit.

getShortDesc

public final java.lang.String getShortDesc()

Gets the short description of the bean. This text is commonly used by user agents to display tooltip help text.

setShortDesc

public final void setShortDesc(java.lang.String shortDesc)

Sets the short description of the bean. This text is commonly used by user agents to display tooltip help text.

getPartialTriggers

public final java.lang.String[] getPartialTriggers()

Gets the IDs of the components that should trigger a partial update. This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too.

setPartialTriggers

public final void setPartialTriggers(java.lang.String[] partialTriggers)

Sets the IDs of the components that should trigger a partial update. This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too.

isUseWindow

public final boolean isUseWindow()

Gets whether to use a new window when launching dialogs. This will be consulted any time the command receives a LaunchEvent.

setUseWindow

public final void setUseWindow(boolean useWindow)

Sets whether to use a new window when launching dialogs. This will be consulted any time the command receives a LaunchEvent.

getWindowWidth

public final int getWindowWidth()

Gets width of the window, if this command is used to launch a window.

setWindowWidth

public final void setWindowWidth(int windowWidth)

Sets width of the window, if this command is used to launch a window.

getWindowHeight

public final int getWindowHeight()

Gets height of the window, if this command is used to launch a window.

setWindowHeight

public final void setWindowHeight(int windowHeight)

Sets height of the window, if this command is used to launch a window.

getOnclick

public final java.lang.String getOnclick()

Gets an onclick Javascript handler.

setOnclick

public final void setOnclick(java.lang.String onclick)

Sets an onclick Javascript handler.

getOndblclick

public final java.lang.String getOndblclick()

Gets an ondblclick Javascript handler.

setOndblclick

public final void setOndblclick(java.lang.String ondblclick)

Sets an ondblclick Javascript handler.

getOnmousedown

public final java.lang.String getOnmousedown()

Gets an onmousedown Javascript handler.

setOnmousedown

public final void setOnmousedown(java.lang.String onmousedown)

Sets an onmousedown Javascript handler.

getOnmouseup

public final java.lang.String getOnmouseup()

Gets an onmouseup Javascript handler.

setOnmouseup

public final void setOnmouseup(java.lang.String onmouseup)

Sets an onmouseup Javascript handler.

getOnmouseover

public final java.lang.String getOnmouseover()

Gets an onmouseover Javascript handler.

setOnmouseover

public final void setOnmouseover(java.lang.String onmouseover)

Sets an onmouseover Javascript handler.

getOnmousemove

public final java.lang.String getOnmousemove()

Gets an onmousemove Javascript handler.

setOnmousemove

public final void setOnmousemove(java.lang.String onmousemove)

Sets an onmousemove Javascript handler.

getOnmouseout

public final java.lang.String getOnmouseout()

Gets an onmouseout Javascript handler.

setOnmouseout

public final void setOnmouseout(java.lang.String onmouseout)

Sets an onmouseout Javascript handler.

getOnkeypress

public final java.lang.String getOnkeypress()

Gets an onkeypress Javascript handler.

setOnkeypress

public final void setOnkeypress(java.lang.String onkeypress)

Sets an onkeypress Javascript handler.

getOnkeydown

public final java.lang.String getOnkeydown()

Gets an onkeydown Javascript handler.

setOnkeydown

public final void setOnkeydown(java.lang.String onkeydown)

Sets an onkeydown Javascript handler.

getOnkeyup

public final java.lang.String getOnkeyup()

Gets an onkeyup Javascript handler.

setOnkeyup

public final void setOnkeyup(java.lang.String onkeyup)

Sets an onkeyup Javascript handler.

getStyleClass

public final java.lang.String getStyleClass()

Gets the CSS style class of the bean.

setStyleClass

public final void setStyleClass(java.lang.String styleClass)

Sets the CSS style class of the bean.

getInlineStyle

public final java.lang.String getInlineStyle()

Gets the inline CSS style for this element

setInlineStyle

public final void setInlineStyle(java.lang.String inlineStyle)

Sets the inline CSS style for this element

isBlocking

public final boolean isBlocking()

Gets If set to TRUE the component will start blocking user input when the action is initiated. The blocking will stop when a response is received from the server.

setBlocking

public final void setBlocking(boolean blocking)

Sets If set to TRUE the component will start blocking user input when the action is initiated. The blocking will stop when a response is received from the server.

getFamily

public java.lang.String getFamily()

Overrides:

getFamily in class UIXCommand

getBeanType

protected FacesBean.Type getBeanType()

Overrides:

getBeanType in class UIXCommand