EE4J 10.0.0 · jakarta.faces.component.behavior.BehaviorBase

Modifier and Type	Field and Description
private boolean	initialState
private List<BehaviorListener>	listeners Our `jakarta.faces.event.BehaviorListener`s.
private boolean	transientFlag

Access	Constructor and Description
public	BehaviorBase()

Modifier and Type	Method and Description
protected void	addBehaviorListener(BehaviorListener The `BehaviorListener` to be registered listener) Add the specified `BehaviorListener` to the set of listeners registered to receive event notifications from this `Behavior`.
public void	broadcast(BehaviorEvent The `BehaviorEvent` to be broadcast event) Implements jakarta.faces.component.behavior.Behavior.broadcast. Default implementation of `Behavior#broadcast`.
public void	clearInitialState() Implements jakarta.faces.component.PartialStateHolder.clearInitialState. Clears the initial state flag, causing the behavior to revert from partial to full state saving.
public boolean	initialStateMarked() Implements jakarta.faces.component.PartialStateHolder.initialStateMarked. Implementation of `jakarta.faces.component.PartialStateHolder#initialStateMarked`.
public boolean	isTransient() Implements jakarta.faces.component.StateHolder.isTransient. Implementation of `jakarta.faces.component.StateHolder#isTransient`.
public void	markInitialState() Implements jakarta.faces.component.PartialStateHolder.markInitialState. Implementation of `jakarta.faces.component.PartialStateHolder#markInitialState`.
protected void	removeBehaviorListener(BehaviorListener The `BehaviorListener` to be deregistered listener) Remove the specified `BehaviorListener` from the set of listeners registered to receive event notifications from this `Behavior`.
public void	restoreState(FacesContext the Faces context. context, Object the state. state) Implements jakarta.faces.component.StateHolder.restoreState. Implementation of `jakarta.faces.component.StateHolder#restoreState`.
public Object	saveState(FacesContext the Faces context. context) Implements jakarta.faces.component.StateHolder.saveState. Implementation of `jakarta.faces.component.StateHolder#saveState`.
public void	setTransient(boolean boolean pass `true` if this Object will not participate in state saving or restoring, otherwise pass `false`. transientFlag) Implements jakarta.faces.component.StateHolder.setTransient. Implementation of `jakarta.faces.component.StateHolder#setTransient`.

initialState	back to summary
private boolean initialState

listeners	back to summary
private List<BehaviorListener> listeners Our `jakarta.faces.event.BehaviorListener`s. This data structure is lazily instantiated as necessary.

transientFlag	back to summary
private boolean transientFlag

BehaviorBase	back to summary
public BehaviorBase()

Method Detail

addBehaviorListener back to summary

addBehaviorListener	back to summary
protected void addBehaviorListener(BehaviorListener listener) Add the specified `BehaviorListener` to the set of listeners registered to receive event notifications from this `Behavior`. It is expected that `Behavior` classes acting as event sources will have corresponding typesafe APIs for registering listeners of the required type, and the implementation of those registration methods will delegate to this method. For example: public class AjaxBehaviorEvent extends BehaviorEvent { ... } public interface AjaxBehaviorListener extends BehaviorListener { public void processAjaxBehavior(FooEvent event); } public class AjaxBehavior extends ClientBehaviorBase { ... public void addAjaxBehaviorListener(AjaxBehaviorListener listener) { addBehaviorListener(listener); } public void removeAjaxBehaviorListener(AjaxBehaviorListener listener) { removeBehaviorListener(listener); } ... } Parameters listener:BehaviorListener The `BehaviorListener` to be registered Exceptions NullPointerException: if `listener` is `null` Since 2.0

protected void addBehaviorListener(BehaviorListener listener)

Add the specified BehaviorListener to the set of listeners registered to receive event notifications from this Behavior. It is expected that Behavior classes acting as event sources will have corresponding typesafe APIs for registering listeners of the required type, and the implementation of those registration methods will delegate to this method. For example:

public class AjaxBehaviorEvent extends BehaviorEvent { ... }

public interface AjaxBehaviorListener extends BehaviorListener {
  public void processAjaxBehavior(FooEvent event);
}

public class AjaxBehavior extends ClientBehaviorBase {
  ...
  public void addAjaxBehaviorListener(AjaxBehaviorListener listener) {
    addBehaviorListener(listener);
  }
  public void removeAjaxBehaviorListener(AjaxBehaviorListener listener) {
    removeBehaviorListener(listener);
  }
  ...
}

Parameters

listener:BehaviorListener: The BehaviorListener to be registered

Exceptions

NullPointerException:: if listener is null

Since

2.0

broadcast back to summary

broadcast	back to summary
public void broadcast(BehaviorEvent event) throws AbortProcessingException Implements jakarta.faces.component.behavior.Behavior.broadcast. Default implementation of `Behavior#broadcast`. Delivers the specified `BehaviorEvent` to all registered `BehaviorListener` event listeners who have expressed an interest in events of this type. Listeners are called in the order in which they were registered (added). Parameters event:BehaviorEvent The `BehaviorEvent` to be broadcast Annotations @Override Exceptions AbortProcessingException: Signal the Jakarta Faces implementation that no further processing on the current event should be performed IllegalArgumentException: if the implementation class of this `BehaviorEvent` is not supported by this component NullPointerException: if `event` is `null` Since 2.0

public void broadcast(BehaviorEvent event) throws AbortProcessingException

Implements jakarta.faces.component.behavior.Behavior.broadcast.

Default implementation of Behavior#broadcast. Delivers the specified BehaviorEvent to all registered BehaviorListener event listeners who have expressed an interest in events of this type. Listeners are called in the order in which they were registered (added).

Parameters

event:BehaviorEvent: The BehaviorEvent to be broadcast

Annotations

@Override

Exceptions

AbortProcessingException:: Signal the Jakarta Faces implementation that no further processing on the current event should be performed
IllegalArgumentException:: if the implementation class of this BehaviorEvent is not supported by this component
NullPointerException:: if event is null

Since

2.0

clearInitialState	back to summary
public void clearInitialState() Implements jakarta.faces.component.PartialStateHolder.clearInitialState. Clears the initial state flag, causing the behavior to revert from partial to full state saving. Annotations @Override

clearInitialState

back to summary

public void clearInitialState()

Implements jakarta.faces.component.PartialStateHolder.clearInitialState.

Clears the initial state flag, causing the behavior to revert from partial to full state saving.

Annotations

@Override

initialStateMarked back to summary

initialStateMarked	back to summary
public boolean initialStateMarked() Implements jakarta.faces.component.PartialStateHolder.initialStateMarked. Implementation of `jakarta.faces.component.PartialStateHolder#initialStateMarked`. Returns:boolean Doc from jakarta.faces.component.PartialStateHolder.initialStateMarked. `true` if the initial state is marked, `false` otherwise. Annotations @Override

public boolean initialStateMarked()

Implements jakarta.faces.component.PartialStateHolder.initialStateMarked.

Implementation of jakarta.faces.component.PartialStateHolder#initialStateMarked.

Returns:boolean

Doc from jakarta.faces.component.PartialStateHolder.initialStateMarked.

true if the initial state is marked, false otherwise.

Annotations

@Override

isTransient back to summary

isTransient	back to summary
public boolean isTransient() Implements jakarta.faces.component.StateHolder.isTransient. Implementation of `jakarta.faces.component.StateHolder#isTransient`. Returns:boolean Doc from jakarta.faces.component.StateHolder.isTransient. `true` if transient, `false` otherwise. Annotations @Override

public boolean isTransient()

Implements jakarta.faces.component.StateHolder.isTransient.

Implementation of jakarta.faces.component.StateHolder#isTransient.

Returns:boolean

Doc from jakarta.faces.component.StateHolder.isTransient.

true if transient, false otherwise.

Annotations

@Override

markInitialState back to summary

markInitialState	back to summary
public void markInitialState() Implements jakarta.faces.component.PartialStateHolder.markInitialState. Implementation of `jakarta.faces.component.PartialStateHolder#markInitialState`. Annotations @Override

public void markInitialState()

Implements jakarta.faces.component.PartialStateHolder.markInitialState.

Implementation of jakarta.faces.component.PartialStateHolder#markInitialState.

Annotations

@Override

removeBehaviorListener back to summary

removeBehaviorListener	back to summary
protected void removeBehaviorListener(BehaviorListener listener) Remove the specified `BehaviorListener` from the set of listeners registered to receive event notifications from this `Behavior`. Parameters listener:BehaviorListener The `BehaviorListener` to be deregistered Exceptions NullPointerException: if `listener` is `null` Since 2.0

protected void removeBehaviorListener(BehaviorListener listener)

Remove the specified BehaviorListener from the set of listeners registered to receive event notifications from this Behavior.

Parameters

listener:BehaviorListener: The BehaviorListener to be deregistered

Exceptions

NullPointerException:: if listener is null

Since

2.0

restoreState back to summary

restoreState	back to summary
public void restoreState(FacesContext context, Object state) Implements jakarta.faces.component.StateHolder.restoreState. Implementation of `jakarta.faces.component.StateHolder#restoreState`. Parameters context:FacesContext Doc from jakarta.faces.component.StateHolder.restoreState. the Faces context. state:Object Doc from jakarta.faces.component.StateHolder.restoreState. the state. Annotations @SuppressWarnings:unchecked @Override

public void restoreState(FacesContext context, Object state)

Implements jakarta.faces.component.StateHolder.restoreState.

Implementation of jakarta.faces.component.StateHolder#restoreState.

Parameters

context:FacesContext

Doc from jakarta.faces.component.StateHolder.restoreState.

the Faces context.

state:Object

Doc from jakarta.faces.component.StateHolder.restoreState.

the state.

Annotations

@SuppressWarnings:unchecked
@Override

saveState back to summary

saveState	back to summary
public Object saveState(FacesContext context) Implements jakarta.faces.component.StateHolder.saveState. Implementation of `jakarta.faces.component.StateHolder#saveState`. Parameters context:FacesContext Doc from jakarta.faces.component.StateHolder.saveState. the Faces context. Returns:Object Doc from jakarta.faces.component.StateHolder.saveState. the saved state. Annotations @Override

public Object saveState(FacesContext context)

Implements jakarta.faces.component.StateHolder.saveState.

Implementation of jakarta.faces.component.StateHolder#saveState.

Parameters

context:FacesContext

Doc from jakarta.faces.component.StateHolder.saveState.

the Faces context.

Returns:Object

Doc from jakarta.faces.component.StateHolder.saveState.

the saved state.

Annotations

@Override

setTransient back to summary

setTransient	back to summary
public void setTransient(boolean transientFlag) Implements jakarta.faces.component.StateHolder.setTransient. Implementation of `jakarta.faces.component.StateHolder#setTransient`. Parameters transientFlag:boolean Doc from jakarta.faces.component.StateHolder.setTransient. boolean pass `true` if this Object will not participate in state saving or restoring, otherwise pass `false`. Annotations @Override

public void setTransient(boolean transientFlag)

Implements jakarta.faces.component.StateHolder.setTransient.

Implementation of jakarta.faces.component.StateHolder#setTransient.

Parameters

transientFlag:boolean

Doc from jakarta.faces.component.StateHolder.setTransient.

boolean pass true if this Object will not participate in state saving or restoring, otherwise pass false.

Annotations

@Override

public Class BehaviorBase

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail