Class ServerAsyncMethod.Event
java.lang.Object
com.webfirmframework.wffweb.tag.html.attribute.event.ServerAsyncMethod.Event
- Enclosing interface:
ServerAsyncMethod
Contains event data for
ServerAsyncMethod.asyncMethod(WffBMObject, Event)
. This class might
be replaced with java record class in future if the minimal java version of
this framework is upgraded to record supported version.-
Constructor Summary
ConstructorDescriptionEvent
(AbstractHtml sourceTag, AbstractAttribute sourceAttribute) Deprecated.Event
(AbstractHtml sourceTag, AbstractAttribute sourceAttribute, Object serverSideData) Event
(WffBMObject data, AbstractHtml sourceTag, AbstractAttribute sourceAttribute, String serverMethodName, Object serverSideData) -
Method Summary
Modifier and TypeMethodDescriptiondata()
Use this method to get data instead of the first parameter fromServerAsyncMethod.asyncMethod(WffBMObject, Event)
method, both contain the same object.Deprecated.useserverMethodName()
method instead as its value cannot be modified in this Event object.Deprecated.useserverSideData()
method instead.Deprecated.usesourceAttribute()
method instead.Deprecated.usesourceTag()
method instead as its value cannot be modified in this Event object.void
setServerMethodName
(String serverMethodName) Deprecated.The use of this method is not encouraged.void
setSourceTag
(AbstractHtml sourceTag) Deprecated.The use of this method is not encouraged.the source attribute from which the event is generated.NB: The deprecatedsetSourceTag(AbstractHtml)
will not affect the value of this method.
-
Constructor Details
-
Event
- Parameters:
serverMethodName
-- Since:
- 3.0.19 deprecated
-
Event
- Parameters:
sourceTag
-sourceAttribute
-- Since:
- 3.0.19 deprecated
-
Event
- Parameters:
serverMethodName
-serverSideData
-- Since:
- 3.0.2, 3.0.19 deprecated
-
Event
@Deprecated public Event(AbstractHtml sourceTag, AbstractAttribute sourceAttribute, Object serverSideData) - Parameters:
sourceTag
-sourceAttribute
-serverSideData
-- Since:
- 3.0.2, 3.0.19 deprecated
-
Event
public Event(WffBMObject data, AbstractHtml sourceTag, AbstractAttribute sourceAttribute, String serverMethodName, Object serverSideData) - Parameters:
data
-sourceTag
-sourceAttribute
-serverMethodName
-serverSideData
-- Since:
- 3.0.19
-
-
Method Details
-
getSourceTag
Deprecated.usesourceTag()
method instead as its value cannot be modified in this Event object. This method will not affect the value ofsourceTag()
method. UsingsourceTag()
is better for keeping java record class standard. This method will be removed only if the minimal java version of this framework is upgraded to a java record class supported version.- Returns:
- the sourceTag
-
setSourceTag
Deprecated.The use of this method is not encouraged. Use constructor initialization instead. This method will be removed only if the minimal java version of this framework is upgraded to a java record class supported version.
Set the sourceTag so that the value ofgetSourceTag()
will return this value.
NB: Calling this method will not affect the value ofsourceTag()
method.- Parameters:
sourceTag
- the sourceTag to set
-
getServerMethodName
Deprecated.useserverMethodName()
method instead as its value cannot be modified in this Event object. UsingserverMethodName()
is better for keeping java record class standard. This method will be removed only if the minimal java version of this framework is upgraded to a java record class supported version.- Returns:
- the serverMethodName
-
setServerMethodName
Deprecated.The use of this method is not encouraged. Use constructor initialization instead. This method will be removed only if the minimal java version of this framework is upgraded to a java record class supported version.
Set the serverMethodName so that the value ofgetServerMethodName()
will return this value.
NB: Calling this method will not affect the value ofserverMethodName()
method.- Parameters:
serverMethodName
-
-
getSourceAttribute
Deprecated.usesourceAttribute()
method instead. UsingsourceAttribute()
is better for keeping java record class standard. This method will be removed only if the minimal java version of this framework is upgraded to a java record class supported version.
This method returns the source attribute from which the event is generated.- Returns:
- the sourceAttribute
- Since:
- 2.1.2
-
getServerSideData
Deprecated.useserverSideData()
method instead. UsingserverSideData()
is better for keeping java record class standard. This method will be removed only if the minimal java version of this framework is upgraded to a java record class supported version.- Returns:
- the server side data passed in the event attribute argument.
- Since:
- 3.0.2
-
sourceTag
NB: The deprecatedsetSourceTag(AbstractHtml)
will not affect the value of this method.- Returns:
- the sourceTag
- Since:
- 3.0.15
-
sourceAttribute
the source attribute from which the event is generated.- Returns:
- the sourceAttribute
- Since:
- 3.0.15
-
serverSideData
- Returns:
- the server side data passed in the event attribute argument.
- Since:
- 3.0.15
-
serverMethodName
- Returns:
- the serverMethodName
- Since:
- 3.0.15
-
data
Use this method to get data instead of the first parameter fromServerAsyncMethod.asyncMethod(WffBMObject, Event)
method, both contain the same object. But, it is recommended to usedata()
method to get the same data as the signature ofServerAsyncMethod.asyncMethod(WffBMObject, Event)
method will be changed to a single parameter method in next major version.- Returns:
- the data
-
Event(com.webfirmframework.wffweb.wffbm.data.WffBMObject,com.webfirmframework.wffweb.tag.html.AbstractHtml,com.webfirmframework.wffweb.tag.html.attribute.core.AbstractAttribute,java.lang.String,java.lang.Object)