Klasse UIButton

java.lang.Object
javax.faces.component.UIComponent
Alle implementierten Schnittstellen:
EventListener, javax.faces.component.ActionSource, javax.faces.component.ActionSource2, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, SupportFieldId, SupportsAccessKey, SupportsAutoSpacing, Visual

@Generated("component.stg") public class UIButton extends AbstractUIButton implements SupportsAccessKey
Renders a button element. UIComponent class, generated from template component.stg with class ButtonTagDeclaration.
  • Feldübersicht

    Felder
    Modifizierer und Typ
    Feld
    Beschreibung
    static final String
     
    static final String
     

    Von Klasse geerbte Felder javax.faces.component.UIComponent

    ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY
  • Konstruktorübersicht

    Konstruktoren
    Konstruktor
    Beschreibung
     
  • Methodenübersicht

    Modifizierer und Typ
    Methode
    Beschreibung
    The access key of this control.
    Automatically add spacing (margins/paddings) to the component for better positioning.
    Text to use as confirmation message.
    Sets a CSS class in its parent, if the parent supports it.
     
     
     
    The identifier of the page fragment which should be brought into focus when the target page is rendered.
    Url to an image to display.
    A localized user presentable label for this component.
    Link to an arbitrary URL, either an internal link or an external link.
     
    Link to an internal facelet page, like the outcome of an action.
    Controls the navigation of the focus through the input controls on a page with the Tab-Key.
    Name of a frame where the resource retrieved via this hyperlink is to be displayed.
    Text value to display as tooltip.
    boolean
    If true the command is executed as default -- for example if the user presses the enter key inside a related input field.
    boolean
    Flag indicating that the action of this element, will not be executed from client side (e. g. when the user clicks a button.
    boolean
    Specify, if the command calls an JSF-Action.
    void
    restoreState(javax.faces.context.FacesContext context, Object state)
     
    void
     
    void
    setAutoSpacing(Boolean autoSpacing)
     
    void
    setConfirmation(String confirmation)
     
    void
     
    void
    setDefaultCommand(boolean defaultCommand)
     
    void
    setFragment(String fragment)
     
    void
     
    void
     
    void
     
    void
    setMarkup(Markup markup)
     
    void
    setOmit(boolean omit)
     
    void
    setOutcome(String outcome)
     
    void
    setTabIndex(Integer tabIndex)
     
    void
    setTarget(String target)
     
    void
     
    void
    setTransition(boolean transition)
     

    Von Klasse geerbte Methoden org.apache.myfaces.tobago.internal.component.AbstractUICommand

    getFieldId, isParentOfCommands

    Von Klasse geerbte Methoden org.apache.myfaces.tobago.internal.component.AbstractUICommandBase

    isDisabled, isRendered, processDecodes, processEvent, queueEvent, setDisabled

    Von Klasse geerbte Methoden javax.faces.component.UICommand

    addActionListener, broadcast, getAction, getActionExpression, getActionListener, getActionListeners, getValue, isImmediate, removeActionListener, setAction, setActionExpression, setActionListener, setImmediate, setValue

    Von Klasse geerbte Methoden javax.faces.component.UIComponentBase

    addClientBehavior, addFacesListener, clearInitialState, decode, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isTransient, markInitialState, processRestoreState, processSaveState, processUpdates, processValidators, removeFacesListener, restoreAttachedState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, visitTree

    Von Klasse geerbte Methoden javax.faces.component.UIComponent

    getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEvent

    Von Klasse geerbte Methoden java.lang.Object

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

    Von Schnittstelle geerbte Methoden javax.faces.component.behavior.ClientBehaviorHolder

    addClientBehavior, getClientBehaviors

    Von Schnittstelle geerbte Methoden org.apache.myfaces.tobago.component.SupportsAutoSpacing

    getAutoSpacing

    Von Schnittstelle geerbte Methoden org.apache.myfaces.tobago.component.Visual

    getRendererType, isPlain
  • Felddetails

    • COMPONENT_TYPE

      public static final String COMPONENT_TYPE
    • COMPONENT_FAMILY

      public static final String COMPONENT_FAMILY
      Siehe auch:
  • Konstruktordetails

    • UIButton

      public UIButton()
  • Methodendetails

    • getEventNames

      public Collection<String> getEventNames()
      Angegeben von:
      getEventNames in Schnittstelle javax.faces.component.behavior.ClientBehaviorHolder
      Setzt außer Kraft:
      getEventNames in Klasse javax.faces.component.UIComponentBase
    • getDefaultEventName

      public String getDefaultEventName()
      Angegeben von:
      getDefaultEventName in Schnittstelle javax.faces.component.behavior.ClientBehaviorHolder
      Setzt außer Kraft:
      getDefaultEventName in Klasse javax.faces.component.UIComponentBase
    • getFamily

      public String getFamily()
      Setzt außer Kraft:
      getFamily in Klasse javax.faces.component.UICommand
    • getImage

      public String getImage()
      Url to an image to display.
      Angegeben von:
      getImage in Klasse AbstractUICommand
    • setImage

      public void setImage(String image)
    • getMarkup

      public Markup getMarkup()
      Angegeben von:
      getMarkup in Schnittstelle Visual
    • setMarkup

      public void setMarkup(Markup markup)
      Angegeben von:
      setMarkup in Schnittstelle Visual
    • getLink

      public String getLink()

      Link to an arbitrary URL, either an internal link or an external link. For internal URLs, a session id will be added, if needed (when cookies disabled). The context path needs to be added manually e.g. #{request.contextPath}. For JSF navigation to a viewId use the outcome attribute!

      The semantic of this attributes has been changed from Tobago 3 to 4!

      Angegeben von:
      getLink in Klasse AbstractUICommandBase
    • setLink

      public void setLink(String link)
    • getTabIndex

      public Integer getTabIndex()
      Controls the navigation of the focus through the input controls on a page with the Tab-Key. The navigation starts from the element with the lowest tabIndex value to the element with the highest value. Elements that have identical tabIndex values should be navigated in the order they appear in the character stream Elements that are disabled or with a negative tabIndex do not participate in the tabbing order.
    • setTabIndex

      public void setTabIndex(Integer tabIndex)
    • getConfirmation

      public String getConfirmation()
      Text to use as confirmation message.
      Angegeben von:
      getConfirmation in Klasse AbstractUICommandBase
    • setConfirmation

      public void setConfirmation(String confirmation)
    • getLabel

      public String getLabel()
      A localized user presentable label for this component.
      Angegeben von:
      getLabel in Schnittstelle SupportsAccessKey
      Angegeben von:
      getLabel in Klasse AbstractUICommand
    • setLabel

      public void setLabel(String label)
    • isTransition

      public boolean isTransition()
      Specify, if the command calls an JSF-Action. Useful to switch off the Double-Submit-Check and Waiting-Behavior.
      Default: true
      Angegeben von:
      isTransition in Klasse AbstractUICommandBase
    • setTransition

      public void setTransition(boolean transition)
    • getTarget

      public String getTarget()
      Name of a frame where the resource retrieved via this hyperlink is to be displayed.
      Angegeben von:
      getTarget in Klasse AbstractUICommandBase
    • setTarget

      public void setTarget(String target)
    • isDefaultCommand

      public boolean isDefaultCommand()
      If true the command is executed as default -- for example if the user presses the enter key inside a related input field.
      Default: false
    • setDefaultCommand

      public void setDefaultCommand(boolean defaultCommand)
    • getFragment

      public String getFragment()
      The identifier of the page fragment which should be brought into focus when the target page is rendered. The value of this attribute is appended to the end of target URL following a hash (#) mark. This notation is part of the standard URL syntax.
      Angegeben von:
      getFragment in Klasse AbstractUICommandBase
    • setFragment

      public void setFragment(String fragment)
    • getAutoSpacing

      public Boolean getAutoSpacing()
      Automatically add spacing (margins/paddings) to the component for better positioning. Default is 'true' except the component is inside a: - header - footer - bar - sheet - tree - link group - button group - before facet - after facet - label facet - bar facet
      Angegeben von:
      getAutoSpacing in Schnittstelle SupportsAutoSpacing
    • setAutoSpacing

      public void setAutoSpacing(Boolean autoSpacing)
    • getAccessKey

      public Character getAccessKey()
      The access key of this control.
      Angegeben von:
      getAccessKey in Schnittstelle SupportsAccessKey
    • setAccessKey

      public void setAccessKey(Character accessKey)
    • getCustomClass

      public CustomClass getCustomClass()
      Sets a CSS class in its parent, if the parent supports it. Which this feature it is possible to put a CSS class name into a component with the <tc:style> tag. Example:
         <tc:in>
           <tc:style customClass="my-emphasized"/>
         </tc:in>
         
      One capability is, to used external CSS libs.
      This feature should not be used imprudent. Because it might be unstable against changes in the renderered HTML code.
      Angegeben von:
      getCustomClass in Schnittstelle Visual
    • setCustomClass

      public void setCustomClass(CustomClass customClass)
      Angegeben von:
      setCustomClass in Schnittstelle Visual
    • getTip

      public String getTip()
      Text value to display as tooltip.
    • setTip

      public void setTip(String tip)
    • isOmit

      public boolean isOmit()
      Flag indicating that the action of this element, will not be executed from client side (e. g. when the user clicks a button. When setting this value to true, the action will not be executed by the Tobago, but it can executed by JavaScript. This attribute is useful, when you want to add JavaScript event handlers to commands manually. In this case you usually don't want a submit with a full reload of the page.
      Default: false
      Angegeben von:
      isOmit in Klasse AbstractUICommandBase
    • setOmit

      public void setOmit(boolean omit)
      Angegeben von:
      setOmit in Klasse AbstractUICommandBase
    • getOutcome

      public String getOutcome()
      Link to an internal facelet page, like the outcome of an action. The context path will be added. A session id will be added, if needed.
      Angegeben von:
      getOutcome in Klasse AbstractUICommandBase
    • setOutcome

      public void setOutcome(String outcome)
    • restoreState

      public void restoreState(javax.faces.context.FacesContext context, Object state)
      Angegeben von:
      restoreState in Schnittstelle javax.faces.component.StateHolder
      Setzt außer Kraft:
      restoreState in Klasse javax.faces.component.UIComponentBase