All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.ibm.beans.samples.dips.splash.SplashScreenDip

java.lang.Object
   |
   +----com.ibm.beans.dip.SimpleDip
           |
           +----com.ibm.beans.samples.dips.splash.SplashScreenDip

public class SplashScreenDip
extends SimpleDip
implements Serializable, DipMethodCallListener, ActionListener
This dip causes a modal dialog containing text and/or an image to be displayed just before the bean to which this dip is applied is displayed.


Constructor Index

 o SplashScreenDip()
Default constructor, invoked when the Dipping Framework calls Beans.instantiate() to create an instance of this dip, in order to apply to a dippable bean.

Method Index

 o actionPerformed(ActionEvent)
Action event received
 o createImplementation(Object)
Indicates whether this dip has a separate implementation class for its policy, and if this dip can be applied to the specified dippable bean.
 o createMethodCallListener(Object, String[])
Wires the dip to receive notification immediately after the specified methods of the dippable bean are called.
 o getImageName()
getImageName
 o getNoticeText()
getNoticeText
 o handleMethodCall(MethodCallEvent)
Responds to a bound method of the dippable bean being invoked.
 o includeInMorphedClass(String)
Indicates whether given method should be "wrapped" during the morphing process.
 o isRemovable()
Indicates whether this dip can be removed from its dipped bean.
 o needsArguments()
Communicates to the dipping framework whether this dip requires the arguments for intercepted methods of the dippable bean.
 o priority()
Returns the priority of this dip in relation to all other dips.
 o setImageName(String)
setImageName
 o setNoticeText(String)
setNoticeText
 o typeName()
Returns the dip type name as a String.

Constructors

 o SplashScreenDip
 public SplashScreenDip()
Default constructor, invoked when the Dipping Framework calls Beans.instantiate() to create an instance of this dip, in order to apply to a dippable bean. After the constructor runs, the dip's createImplementation() method will be invoked.

See Also:
createImplementation

Methods

 o typeName
 public String typeName()
Returns the dip type name as a String. The typeName() method of SimpleDip is abstract, so typeName() must be implemented here.

Returns:
A descriptive string describing the type of dip.
Overrides:
typeName in class SimpleDip
See Also:
typeName
 o priority
 public int priority()
Returns the priority of this dip in relation to all other dips. This priority is used to determine which dips are acted on first. The default priority is 500 - a higher number means the dip gets notifications before other dips.

Returns:
The desired priority of this dip.
Overrides:
priority in class SimpleDip
See Also:
priority
 o isRemovable
 public boolean isRemovable()
Indicates whether this dip can be removed from its dipped bean.

Returns:
boolean indicating if dip can be removed.
Overrides:
isRemovable in class SimpleDip
See Also:
isRemovable
 o includeInMorphedClass
 public boolean includeInMorphedClass(String methodName)
Indicates whether given method should be "wrapped" during the morphing process. This method will be called once for each method as the bean is morphed. Returning true causes the method to be overriden in the subclass, and to have the instrumentation generated in the overriden method allowing it to be hooked by dips. The more methods that are wrapped, the larger the subclass for the dippable bean will be.

Returns:
boolean indicating if method should be wrapped.
Overrides:
includeInMorphedClass in class SimpleDip
See Also:
includeInMorphedClass
 o createImplementation
 public Object createImplementation(Object obj) throws DipRejectAdditionException
Indicates whether this dip has a separate implementation class for its policy, and if this dip can be applied to the specified dippable bean.

Parameters:
obj - The bean being dipped. This is the only reference to this dip's dippable bean that will ever be provided to the dip.
Returns:
null, indicating this dip implements its own policy.
Throws: DipRejectAdditionException
This exception is thrown if the dip rejects being added to the bean.
Overrides:
createImplementation in class SimpleDip
See Also:
createImplementation
 o createMethodCallListener
 public DipMethodCallListener[] createMethodCallListener(Object impl,
                                                         String methods[]) throws DipRejectAdditionException
Wires the dip to receive notification immediately after the specified methods of the dippable bean are called.

Parameters:
impl - This value should be null. There is no separate implementation.
methods - An array of method signatures from the dippable bean.
Returns:
Array of DipMethodCallListeners with this dip set to listen at the appropriate method indices.
Throws: DipRejectAdditionException
This exception is thrown if the dip rejects being added to the bean.
Overrides:
createMethodCallListener in class SimpleDip
See Also:
handleMethodCall, createMethodCallListener
 o needsArguments
 public boolean needsArguments()
Communicates to the dipping framework whether this dip requires the arguments for intercepted methods of the dippable bean. Returning false avoids the performance impact of parameter marshaling.

Returns:
boolean indicating whether this dip requires the arguments from intercepted methods.
See Also:
needsArguments
 o handleMethodCall
 public void handleMethodCall(MethodCallEvent evt)
Responds to a bound method of the dippable bean being invoked.

Parameters:
evt - A MethodCallEvent object describing the event source and the property that changed.
See Also:
handleMethodCall
 o getNoticeText
 public String getNoticeText()
getNoticeText

Returns:
Value of NoticeText property
See Also:
setNoticeText
 o setNoticeText
 public synchronized void setNoticeText(String value)
setNoticeText

Parameters:
value - New value of NoticeText property
See Also:
getNoticeText
 o getImageName
 public String getImageName()
getImageName

Returns:
Value of ImageName property
See Also:
setImageName
 o setImageName
 public synchronized void setImageName(String value)
setImageName

Parameters:
value - New value of ImageName property
See Also:
getImageName
 o actionPerformed
 public void actionPerformed(ActionEvent event)
Action event received


All Packages  Class Hierarchy  This Package  Previous  Next  Index