Difference between revisions of "Codeunit/Formevents"
Jump to navigation
Jump to search
(9 intermediate revisions by one other user not shown) | |||
Line 19: | Line 19: | ||
# '''beforeSelectList''' | # '''beforeSelectList''' | ||
# Gather form data from database | # Gather form data from database | ||
#* '''dataFilterActive > dataFilterHandler''' | |||
#* '''listFilterActive > listFilterHandler''' | |||
# '''beforeRenderList''' | # '''beforeRenderList''' | ||
# Return list to user | # Return list to user | ||
Line 40: | Line 42: | ||
# '''beforeSelectItem''' | # '''beforeSelectItem''' | ||
# Gather form data from database | # Gather form data from database | ||
#* '''dataFilterActive > dataFilterHandler''' | |||
#* '''itemFilterActive > itemFilterHandler''' | |||
# '''beforeRenderItem''' | # '''beforeRenderItem''' | ||
# Return form to user | # Return form to user | ||
==== ITEM execution order: posting data ==== | ==== ITEM execution order: posting data ==== | ||
Line 60: | Line 63: | ||
== FILTER event hooks == | == FILTER event hooks == | ||
Filters will help you build customized permission schemes. They are called for '''both''' LIST and ITEM commands. | |||
@Override | |||
protected boolean dataFilterActive() { | |||
return true; | |||
} | |||
@Override | |||
protected void dataFilterHandler(StringBuilder sql) { | |||
sql.append(" AND something"); | |||
} | |||
In some cases you only want the filter to trigger for '''either''' LIST or ITEM commands | |||
itemFilterActive() {} | |||
itemFilterHandler(StringBuilder sql) {} | |||
listFilterActive() {} | |||
listFilterHandler(StringBuilder sql) {} | |||
=== Examples === | |||
The xxxFilterActive tells if the filter is active | |||
boolean dataFilterActive() { return ! s.isAdministor(); } | |||
The xxxFilterHandler modifies the SQL used to fetch data | |||
void dataFilterHandler(StringBuilder sql) { sql.append(" AND CATEGORY NOT IN (123,456,789)"); } | |||
== Event firing details == | == Event firing details == |
Latest revision as of 16:55, 25 June 2025
Form events fires different actions during execution of a solution
Creating the codeunit
- Make sure that p2eShared.jar is included in the project
- Create a new class that extends
com.tsnocode.codeunit.CodeunitFormevents
LIST level event hooks
public String appendListPageHead() { return ""; } public String appendListPageFoot() { return ""; }
public void beforeSelectList() throws Exception {} public void beforeRenderList() throws Exception {}
LIST execution order
- beforeSelectList
- Gather form data from database
- dataFilterActive > dataFilterHandler
- listFilterActive > listFilterHandler
- beforeRenderList
- Return list to user
ITEM level event hooks
public String appendItemPageHead() { return ""; } public String appendItemPageFoot() { return ""; }
public void beforeSelectItem() throws Exception {} public void beforeChangeItem() throws Exception {} public void beforeUpdateItem() throws Exception {} public void beforeRenderItem() throws Exception {} public void afterUpdateItem() throws Exception { return false; } public boolean afterUpdateRedirectActive() { return false; } public String afterUpdateRedirectContent() { return null; }
ITEM execution order: viewing data
- beforeSelectItem
- Gather form data from database
- dataFilterActive > dataFilterHandler
- itemFilterActive > itemFilterHandler
- beforeRenderItem
- Return form to user
ITEM execution order: posting data
- beforeSelectItem
- Gather form data from database
- beforeChangeItem
- Update field values
- beforeUpdateItem
- Write changes to database
- afterUpdateItem
- if NO OTHER ACTION:
- afterUpdateRedirectActive
- if TRUE
- afterUpdateRedirectContent
- Return content to user
FILTER event hooks
Filters will help you build customized permission schemes. They are called for both LIST and ITEM commands.
@Override protected boolean dataFilterActive() { return true; } @Override protected void dataFilterHandler(StringBuilder sql) { sql.append(" AND something"); }
In some cases you only want the filter to trigger for either LIST or ITEM commands
itemFilterActive() {} itemFilterHandler(StringBuilder sql) {}
listFilterActive() {} listFilterHandler(StringBuilder sql) {}
Examples
The xxxFilterActive tells if the filter is active
boolean dataFilterActive() { return ! s.isAdministor(); }
The xxxFilterHandler modifies the SQL used to fetch data
void dataFilterHandler(StringBuilder sql) { sql.append(" AND CATEGORY NOT IN (123,456,789)"); }
Event firing details
Event firing global
The following events are ALLWAYS fired
- beforeSelectList
- beforeSelectItem
- beforeChangeItem
- beforeUpdateItem
- afterUpdateItem
Event firing in UI (reserved for normal users)
The following events will NOT be fired during imports etc.
- appendListPageHead
- appendListPageFoot
- beforeRenderList
- appendItemPageHead
- appendItemPageFoot
- beforeRenderItem
Event firing in UI depending on user actions
The following events are SOMETIMES be fired for normal users depending on navigation
- afterUpdateRedirectActive
- Not executed in SUBFORM mode
- Not executed in during imports etc.
- afterUpdateRedirectContent
- Depends on a TRUE result from afterUpdateRedirectActive()