diff --git a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/AdempiereWebUI.java b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/AdempiereWebUI.java
index 87fd3229db..995edae029 100644
--- a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/AdempiereWebUI.java
+++ b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/AdempiereWebUI.java
@@ -81,7 +81,7 @@ import org.zkoss.zul.Style;
import org.zkoss.zul.Window;
/**
- *
+ * Entry point for iDempiere web client
* @author Ashley G Ramdass
* @date Feb 25, 2007
* @version $Revision: 0.10 $
@@ -90,10 +90,10 @@ import org.zkoss.zul.Window;
*/
public class AdempiereWebUI extends Window implements EventListener, IWebClient
{
- /** {@link Session} attribute to hold current login user id value **/
+ /** {@link Session} attribute to hold current login user id value */
public static final String CHECK_AD_USER_ID_ATTR = "Check_AD_User_ID";
- /** Boolean attribute to indicate the HTTP session of a Desktop have been invalidated **/
+ /** Boolean attribute to indicate the HTTP session of a Desktop have been invalidated */
public static final String DESKTOP_SESSION_INVALIDATED_ATTR = "DesktopSessionInvalidated";
/**
@@ -101,28 +101,34 @@ public class AdempiereWebUI extends Window implements EventListener, IWeb
*/
private static final long serialVersionUID = -6725805283410008847L;
- /** {@link Desktop} attribute to hold {@link IDesktop} reference **/
+ /** {@link Desktop} attribute to hold {@link IDesktop} reference */
public static final String APPLICATION_DESKTOP_KEY = "application.desktop";
+ /** org.zkoss.zk.ui.WebApp.name preference from zk.xml */
public static String APP_NAME = null;
+ /** Match to version at lang-addon.xml */
public static final String UID = "1.0.0";
- /** Attribute for widget instance name, use for Selenium test **/
+ /** Attribute for widget instance name, use for Selenium test */
public static final String WIDGET_INSTANCE_NAME = "instanceName";
- /** login and role selection window **/
+ /** login and role selection window */
private WLogin loginDesktop;
- /** client info from browser **/
+ /** client info from browser */
private ClientInfo clientInfo = new ClientInfo();
+ /** Language for current session */
private String langSession;
+ /** Current login user's preference */
private UserPreference userPreference;
+ /** User preference DB model */
private MUserPreference userPreferences;
+ /** Global key listener */
private Keylistener keyListener;
private static final CLogger logger = CLogger.getCLogger(AdempiereWebUI.class);
@@ -130,15 +136,16 @@ public class AdempiereWebUI extends Window implements EventListener, IWeb
@Deprecated(forRemoval = true, since = "11")
public static final String EXECUTION_CARRYOVER_SESSION_KEY = "execution.carryover";
- /** Session attribute to hold {@link ClientInfo} reference **/
+ /** Session attribute to hold {@link ClientInfo} reference */
private static final String CLIENT_INFO = "client.info";
/** the use of event thread have been deprecated, this should always be false **/
private static boolean eventThreadEnabled = false;
+ /** Parameters map from browser URL */
private ConcurrentMap m_URLParameters;
- /** Login completed event **/
+ /** Login completed event */
private static final String ON_LOGIN_COMPLETED = "onLoginCompleted";
/**
@@ -149,7 +156,7 @@ public class AdempiereWebUI extends Window implements EventListener, IWeb
this.setVisible(false);
userPreference = new UserPreference();
- // preserve the original URL parameters as is destroyed later on loging
+ // preserve the original URL parameters as is destroyed later on login
m_URLParameters = new ConcurrentHashMap(Executions.getCurrent().getParameterMap());
this.addEventListener(ON_LOGIN_COMPLETED, this);
@@ -711,7 +718,7 @@ public class AdempiereWebUI extends Window implements EventListener, IWeb
}
/**
- * change role, asynchronous callback from {@link IDesktop#logout(org.adempiere.util.Callback)}
+ * change role, asynchronous callback from {@link #changeRole(MUser)}
* @param httpSession
* @param locale
* @param properties
diff --git a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/DefaultWebAppInit.java b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/DefaultWebAppInit.java
index c84745d2b3..265c4fd974 100644
--- a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/DefaultWebAppInit.java
+++ b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/DefaultWebAppInit.java
@@ -29,17 +29,17 @@ import org.zkoss.zk.ui.WebApp;
import org.zkoss.zk.ui.util.WebAppInit;
/**
- * Handle web app init event to sync config store in web config file and database
+ * Handle web app init event to manage configuration from zk.xml and AD_SysConfig
* @author hieplq
*
*/
public class DefaultWebAppInit implements WebAppInit {
-
+ /** AD_SysConfig change listener */
private static SystemConfigHandler systemConfigChangeHandler;
protected WebApp webApp = null;
/**
- * Register listen model change
+ * Register model change listener
*/
@Override
public void init(WebApp wapp) throws Exception {
@@ -67,7 +67,7 @@ public class DefaultWebAppInit implements WebAppInit {
}
/**
- * Process model event of table system config
+ * Process model event of AD_SysConfig table
* @author hieplq
*
*/
@@ -177,7 +177,7 @@ public class DefaultWebAppInit implements WebAppInit {
*/
protected void afterChange (PO po){
if (po instanceof X_AD_SysConfig){
- // when change ZK_BROWSER_TITLE, set web config to new value
+ // after change of ZK_BROWSER_TITLE, set app name of webApp to new value
if (MSysConfig.ZK_BROWSER_TITLE.equals(((X_AD_SysConfig) po).getName())){
String configAppname = ((X_AD_SysConfig) po).getValue();
webApp.setAppName(configAppname);
diff --git a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/Extensions.java b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/Extensions.java
index 2a62f8cc40..bf10054b7b 100644
--- a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/Extensions.java
+++ b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/Extensions.java
@@ -57,11 +57,11 @@ import org.zkoss.zk.ui.Component;
*/
public class Extensions {
+ /** FormId:IFormFactory Reference. FormId is Java class name, OSGi component name or Equinox extension Id */
private final static CCache> s_formFactoryCache = new CCache<>(null, "IFormFactory", 100, false);
/**
- *
- * @param formId Java class name or equinox extension Id
+ * @param formId Java class name, OSGi component name or equinox extension Id
* @return IFormController instance or null if formId not found
*/
public static ADForm getForm(String formId) {
@@ -91,13 +91,14 @@ public class Extensions {
return null;
}
+ /** CacheKey:IProcessParameterListener Reference. CacheKey is ProcessClassName|ColumnName */
private final static CCache>> s_processParameterListenerCache = new CCache<>(null, "List", 100, false);
/**
*
- * @param processClass
+ * @param processClass Java class name of process
* @param columnName
- * @return list of parameter listener
+ * @return list of {@link IProcessParameterListener}
*/
public static List getProcessParameterListeners(String processClass, String columnName) {
String cacheKey = processClass + "|" + columnName;
@@ -116,10 +117,10 @@ public class Extensions {
return listeners.stream().filter(e -> e.getService() != null).map(e -> e.getService()).collect(Collectors.toCollection(ArrayList::new));
}
+ /** AD_Tab_ID:ICreateFromFactory Reference */
private final static CCache> s_createFromFactoryCache = new CCache<>(null, "ICreateFromFactory", 100, false);
/**
- *
* @param mTab
* @return ICreateFrom instance
*/
@@ -154,11 +155,12 @@ public class Extensions {
return null;
}
+ /** CacheKey:IPaymentFormFactory Reference. CacheKey is AD_Tab_ID|Payment Rule */
private static final CCache> s_paymentFormFactoryCache = new CCache<>(null, "IPaymentFormFactory", 100, false);
+
/**
- *
* @param windowNo
- * @param mTab
+ * @param mTab GridTab
* @param paymentRule
* @return IPaymentForm instance
*/
@@ -189,10 +191,10 @@ public class Extensions {
return null;
}
+ /** URL:IDashboardGadgetFactory Reference */
private static final CCache> s_dashboardGadgetFactoryCache = new CCache<>(null, "IDashboardGadgetFactory", 100, false);
/**
- *
* @param url
* @param parent
* @return Gadget component
@@ -202,7 +204,6 @@ public class Extensions {
}
/**
- *
* @param url
* @param parent
* @param dc
@@ -225,8 +226,10 @@ public class Extensions {
IDashboardGadgetFactory service = factory.getService();
if (service != null) {
Component component = service.getGadget(url,parent,dc);
- if(component != null)
+ if (component != null) {
+ s_dashboardGadgetFactoryCache.put(url, factory);
return component;
+ }
}
}
@@ -234,7 +237,6 @@ public class Extensions {
}
/**
- *
* @return list of {@link IChartRendererService}
*/
public static final List getChartRendererServices() {
@@ -244,8 +246,7 @@ public class Extensions {
private static IServiceReferenceHolder s_mappedFormFactoryReference = null;
/**
- *
- * @return {@link IMappedFormFactory}
+ * @return {@link IMappedFormFactory} instance
*/
public static IMappedFormFactory getMappedFormFactory(){
IMappedFormFactory formFactoryService = null;
@@ -261,12 +262,12 @@ public class Extensions {
}
return formFactoryService;
}
-
+
+ /** AD_Window_ID:IQuickEntryFactory Reference */
private final static CCache> s_quickEntryFactoryCache = new CCache<>(null, "IQuickEntryFactory", 100, false);
/**
- *
- * @param AdWindowID
+ * @param AdWindowID AD_Window_ID
* @return IQuickEntryFactory instance or null if AdWindowID not found
*/
public static AbstractWQuickEntry getQuickEntry(Integer AdWindowID) {
@@ -297,10 +298,9 @@ public class Extensions {
}
/**
- *
* @param WindowNo
* @param TabNo
- * @param AdWindowID
+ * @param AdWindowID AD_Window_ID
* @return IQuickEntry instance or null if AdWindowID not found
*/
public static AbstractWQuickEntry getQuickEntry(int WindowNo, int TabNo, int AdWindowID) {
@@ -330,14 +330,14 @@ public class Extensions {
return null;
}
+ /** CacheKey:IMediaViewProvider Reference. CacheKey is ContentType|File Extension */
private static final CCache> s_mediaViewProviderCache = new CCache<>("_IMediaViewProvider_Cache", "IMediaViewProvider", 100, false);
/**
- *
* @param contentType
* @param extension
- * @param mobile
- * @return {@link IMediaView}
+ * @param mobile true for mobile, otherwise for desktop
+ * @return {@link IMediaView} instance
*/
public static IMediaView getMediaView(String contentType, String extension, boolean mobile) {
String key = contentType + "|" + extension;
@@ -373,7 +373,7 @@ public class Extensions {
/**
* @param tabType build in - FORM or SORT, custom - through IADTabPanelFactory extension
- * @return {@link IADTabpanel}
+ * @return {@link IADTabpanel} instance
*/
public static IADTabpanel getADTabPanel(String tabType)
{
diff --git a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/ISupportMask.java b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/ISupportMask.java
index ca6eaee473..0a3a845044 100644
--- a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/ISupportMask.java
+++ b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/ISupportMask.java
@@ -18,50 +18,51 @@ import org.adempiere.webui.part.AbstractUIPart;
import org.zkoss.zk.ui.Component;
/**
- * interface for any component want support show other window over it with a
- * mask. object manage component as AbstractUIPart also implement this interface
- * consider below case.
+ * Interface for any component want support show other window over it with a
+ * mask. Class manage component as AbstractUIPart also implement this interface.
+ * Consider following scenario:
+ *
* 1. show a dialog => show mask
- * 2. process a event
+ * 2. process an event
* 2.1. show other dialog => show mask
- * 2.1. hidden dialog in step 1 => hidden mask
+ * 2.1. hide dialog in step 1 => hide mask
* 3. result dialog show without mask
- * to void this case process as below
- * in {@link #showMask()} set a flag to request scope by call: {@link Component#setAttribute(String, Object, int)}
- * key is {@link #READY_SHOW_MASK_FLAG} value is Integer(1) and scope is {@link Component#REQUEST_SCOPE}
- * in {@link #hideMask()} check flag before hidden mask. when has flag, don't hidden mask
- *
- * component want support show mask can implement this interface or use support class {@link ShowMaskWrapper} as composite object
+ *
+ * To void this issue, proceed as below:
+ * - In {@link #showMask()} set a flag to request scope by call {@link Component#setAttribute(String, Object, int)}
+ * with name {@link #READY_SHOW_MASK_FLAG}, value Integer(1) and scope {@link Component#REQUEST_SCOPE}.
+ * - In {@link #hideMask()} check flag before hide mask. When has flag, don't hide mask.
+ *
+ * Component want support show mask can implement this interface or use support class {@link ShowMaskWrapper} as composite object
*/
public interface ISupportMask {
public static String READY_SHOW_MASK_FLAG = "ISupportMask_READY_SHOW_MASK_FLAG";
/**
- * show mask over this component
- * when override, remember call {@link Component#setAttribute(String, Object, int)} with
- * key is {@link #READY_SHOW_MASK_FLAG} value is Integer(1) and scope is {@link Component#REQUEST_SCOPE}
- * by call {@link LayoutUtils}
+ * Show mask over this component.
+ * When override, remember to call {@link Component#setAttribute(String, Object, int)} with
+ * name {@link #READY_SHOW_MASK_FLAG}, value Integer(1) and scope {@link Component#REQUEST_SCOPE}.
+ * Call by {@link LayoutUtils}.
*/
public void showMask();
/**
- * Hide mask. at code call showMask will hand reference to this object. and
- * call this function in handle close event of window
- * when override, remember check exists of key {@link #READY_SHOW_MASK_FLAG} at scope {@link Component#REQUEST_SCOPE} in attribute
- * by call {@link LayoutUtils}
- * if exists flag, don't hidden mask
+ * Hide mask. With ISupportMask return from showMask, call this function in handle close event of window.
+ * When override, remember check exists of key {@link #READY_SHOW_MASK_FLAG} at scope {@link Component#REQUEST_SCOPE} in attribute.
+ * If flag exists, don't hide mask.
+ * Call by {@link LayoutUtils}.
*/
public void hideMask();
/**
- * return cache object or make new object and return
- * @return
+ * Return cache Mask or create new Mask and return.
+ * @return {@link Mask}
*/
public Mask getMaskObj();
/**
- * return self if is a component or return component it manage
- * if {@link AbstractUIPart} is implement this interface, return {@link AbstractUIPart#getComponent()}
- * @return
+ * Return self if is a component or return component it manage.
+ * {@link AbstractUIPart} subclasses that implement this interface should return {@link AbstractUIPart#getComponent()}.
+ * @return {@link Component}
*/
public Component getMaskComponent();
}
\ No newline at end of file
diff --git a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/LayoutUtils.java b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/LayoutUtils.java
index 6778c507f3..2a638b4f9d 100644
--- a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/LayoutUtils.java
+++ b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/LayoutUtils.java
@@ -318,17 +318,18 @@ public final class LayoutUtils {
public static final int OVERLAP_SELF = 4;
/**
- * show window with a mask below. mask over tabPanel, all window or only over a control, dependency ownModel flag.
- * when ownModel == {@link #OVERLAP_SELF}, window show overlap childOfOwn,
- * when childOfOwn doesn't implement {@link ISupportMask} make new {@link Mask} object to make mask layout
- * ownModel == {@link #OVERLAP_ALL_PAGE}, window show overlap all page
- * ownModel == {@link #OVERLAP_TAB_PANEL}, window show overlap tabPanel
- * ownModel == {@link #OVERLAP_PARENT}, search near parent of childOfOwn implement {@link ISupportMask} if not exist user as OVERLAP_ALL_PAGE
+ * show window with a mask below. Depends on ownModel flag, mask is shown over tabPanel, all window or over a component.
+ *
+ * when ownModel is
+ * - {@link #OVERLAP_SELF}, mask childOfOwn. if childOfOwn doesn't implement {@link ISupportMask}, make new {@link Mask} object to mask it
+ * - {@link #OVERLAP_ALL_PAGE}, window show overlap all page
+ * - {@link #OVERLAP_TAB_PANEL}, window show overlap tabPanel
+ * - {@link #OVERLAP_PARENT}, search nearest parent of childOfOwn that implement {@link ISupportMask}, if not found use as OVERLAP_ALL_PAGE
+ *
* @param window
- * @param childOfOwn
+ * @param childOfOwn Component below window
* @param ownModel OVERLAP_TAB_PANEL, OVERLAP_ALL_PAGE, OVERLAP_PARENT or OVERLAP_SELF
- * @return when show success return IMask object, it is own window, use {@link ISupportMask#hideMask()} to hidden mask.
- * other return null.
+ * @return when show success return ISupportMask object, use {@link ISupportMask#hideMask()} to hide mask.
*/
public static ISupportMask showWindowWithMask(Window window, Component childOfOwn, int ownModel){
ISupportMask ownWindow = null;
@@ -392,7 +393,7 @@ public final class LayoutUtils {
}
/**
- * find parent of child component, parent must implement {@link ISupportMask}
+ * find nearest parent of child component that implement {@link ISupportMask}.
* if parentClass != null, parent class must extends parentClass
* @param child
* @param parentClass
@@ -414,7 +415,7 @@ public final class LayoutUtils {
}
/**
- * Compact grid to limit (for e.g, to max of 2 column)
+ * Compact grid to limit (for e.g, to max of 2 column).
* Note: doesn't handle row span
* @param grid
* @param limit
@@ -479,7 +480,7 @@ public final class LayoutUtils {
}
/**
- * Expand grid to min (for e.g, to min of 2 column)
+ * Expand grid to min (for e.g, to min of 2 column).
* Note: doesn't handle row span
* @param grid
* @param min
@@ -550,7 +551,7 @@ public final class LayoutUtils {
}
/**
- * find first popup ancestor of comp
+ * find first Popup ancestor of comp
* @param comp
* @return {@link Popup} if comp or one of its ancestor is Popup
*/
diff --git a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/LoggedSessionListener.java b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/LoggedSessionListener.java
index a32895324e..f09e4e5c13 100644
--- a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/LoggedSessionListener.java
+++ b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/LoggedSessionListener.java
@@ -49,6 +49,7 @@ import org.compiere.util.WebUtil;
* Sync state of {@link HttpSession} and AD_Session
*/
public class LoggedSessionListener implements HttpSessionListener, ServletContextListener, ServerStateChangeListener{
+ /** Http Session Id:HttpSession */
private static Hashtable AD_SessionList = new Hashtable();
private static final CLogger logger = CLogger.getCLogger(LoggedSessionListener.class);
@@ -107,6 +108,9 @@ public class LoggedSessionListener implements HttpSessionListener, ServletContex
*/
}
+ /**
+ * Update all active AD_Session records (Processed=N) to inactive (Processed=Y)
+ */
private void DestroyAllSession() {
if (!Adempiere.isStarted())
{
@@ -124,6 +128,11 @@ public class LoggedSessionListener implements HttpSessionListener, ServletContex
Adempiere.removeServerStateChangeListener(this);
}
+ /**
+ * Update AD_Session record to inactive (Processed=Y) by session id and server name
+ * @param sessionID Http Session Id
+ * @param serverName
+ */
private void removeADSession(String sessionID, String serverName) {
String sql = "UPDATE AD_Session SET Processed='Y' WHERE WebSession=? AND ServerName=? AND Processed='N'";
int no = DB.executeUpdate(sql, new Object[] {sessionID, serverName}, false, null);
diff --git a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/ShowMaskWrapper.java b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/ShowMaskWrapper.java
index 6bbd56071e..dcf9e1e4bf 100644
--- a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/ShowMaskWrapper.java
+++ b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/ShowMaskWrapper.java
@@ -21,8 +21,8 @@ import org.zkoss.zk.ui.Component;
import org.zkoss.zk.ui.util.Clients;
/**
- * Helper class for {@link ISupportMask} implementation
- * Just make a instance of this class and let it do everything
+ * Helper class for {@link ISupportMask} implementation.
+ * Just make a instance of this class and let it do everything.
* @author hieplq
*
*/
@@ -117,9 +117,9 @@ public class ShowMaskWrapper implements ISupportMask {
}
/**
- * check flag {@link ISupportMask#READY_SHOW_MASK_FLAG} ready in scope Component.REQUEST_SCOPE
+ * check flag {@link ISupportMask#READY_SHOW_MASK_FLAG} exists in scope Component.REQUEST_SCOPE
* @param comp
- * @return
+ * @return true if flag exists
*/
public static boolean hasFlagShowMask (Component comp){
return (comp.getAttribute(ISupportMask.READY_SHOW_MASK_FLAG, Component.REQUEST_SCOPE) != null);
diff --git a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/ValuePreference.java b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/ValuePreference.java
index 287200505e..b0572ad4fb 100644
--- a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/ValuePreference.java
+++ b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/ValuePreference.java
@@ -133,7 +133,7 @@ public class ValuePreference extends Window implements EventListener
AD_Client_ID, AD_Org_ID, AD_User_ID, AD_Window_ID, mField.getAD_Process_ID_Of_Panel(), mField.getAD_InfoWindow_ID_of_Panel(),
Attribute, DisplayAttribute, Value, DisplayValue,
displayType, AD_Reference_ID, ref);
- } // create
+ } // start
/** The Name of the Dialog */
public static final String NAME = "ValuePreference";
@@ -438,7 +438,7 @@ public class ValuePreference extends Window implements EventListener
} // dynInit
/**
- * Action Listener
+ * Event Listener
* @param e event
*/
public void onEvent(Event e) throws Exception
@@ -573,9 +573,9 @@ public class ValuePreference extends Window implements EventListener
} // delete
/**
- * Get Context Key
- * preferences in context update follow key.
- * they load when login, and update when change.
+ * Get Context Key.
+ * Preferences in context update follow key.
+ * They load when login, and update when change.
* @see Login#loadPreferences(org.compiere.util.KeyNamePair, org.compiere.util.KeyNamePair, java.sql.Timestamp, String)
* and set to field when display field, {@link GridField#getDefault()}
* @return Context Key
diff --git a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/WArchive.java b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/WArchive.java
index 658e58212a..fb56c63e94 100644
--- a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/WArchive.java
+++ b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/WArchive.java
@@ -140,7 +140,7 @@ public class WArchive implements EventListener
LayoutUtils.autoDetachOnClose(m_popup);
}
m_popup.open(invoker, "after_start");
- } // getZoomTargets
+ } // getArchives
/**
* Listener
diff --git a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/WLogin.java b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/WLogin.java
index 48c0240573..2ac97b6ae2 100644
--- a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/WLogin.java
+++ b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/WLogin.java
@@ -42,13 +42,13 @@ import org.zkoss.zul.Window;
*/
public class WLogin extends AbstractUIPart
{
- /** IWebClient instance ({@link AdempiereWebUI}) **/
+ /** IWebClient instance ({@link AdempiereWebUI}) */
private IWebClient app;
- /** Main layout **/
+ /** Main layout */
private Borderlayout layout;
@Deprecated(forRemoval = true, since = "11")
private Window browserWarningWindow;
- /** embedded window for login and role selection **/
+ /** embedded window for login and role selection */
private LoginWindow loginWindow;
/**
@@ -61,7 +61,9 @@ public class WLogin extends AbstractUIPart
}
/**
- * Create UI from login.zul file. The main layout component ("layout") must be instance of {@link Borderlayout}.
+ * Create UI from login.zul file.
+ * The main layout component ("layout") must be instance of {@link Borderlayout}.
+ * Get {@link #loginWindow} reference from zul using id "loginWindow".
*/
@Override
protected Component doCreatePart(Component parent)
diff --git a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/WRequest.java b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/WRequest.java
index dba54819dc..662b2c6120 100644
--- a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/WRequest.java
+++ b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/WRequest.java
@@ -62,7 +62,7 @@ public class WRequest implements EventListener
m_C_BPartner_ID = C_BPartner_ID;
getRequests(invoker);
- } // AReport
+ } // WRequest
/** The Table */
private int m_AD_Table_ID;
diff --git a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/WebUIActivator.java b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/WebUIActivator.java
index 3c8bc47e50..6218e057b2 100644
--- a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/WebUIActivator.java
+++ b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/WebUIActivator.java
@@ -18,8 +18,8 @@ import org.osgi.framework.BundleActivator;
import org.osgi.framework.BundleContext;
/**
- * {@link BundleActivator} for web UI
- * Start {@link WindowValidatorManager}
+ * {@link BundleActivator} for web client.
+ * Start {@link WindowValidatorManager}.
* @author hengsin
*/
public class WebUIActivator implements BundleActivator {
diff --git a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/action/Actions.java b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/action/Actions.java
index 48114dffab..a0a1c6cf3d 100644
--- a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/action/Actions.java
+++ b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/action/Actions.java
@@ -58,10 +58,10 @@ public class Actions {
}
/**
- * Image name: actionId+"24.png".
- * Get image from current theme or plugin resource.
+ * Image name: actionId+"24.png".
+ * Get image from current theme or plugin resource.
* For plugin resource, it will try the path /action/images/{theme}/{image name}, /action/images/default/{image name} and
- * /action/images/{image name}
+ * /action/images/{image name}.
* @param actionId
* @return {@link AImage}
*/
diff --git a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/adwindow/ADTabpanel.java b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/adwindow/ADTabpanel.java
index f721052ff7..0354d42a48 100644
--- a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/adwindow/ADTabpanel.java
+++ b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/adwindow/ADTabpanel.java
@@ -129,11 +129,6 @@ import org.zkoss.zul.impl.XulElement;
/**
* UI for an AD_Tab content (AD_Tab + AD_Fields).
*
- * This class is based on org.compiere.grid.GridController written by Jorg Janke.
- * Changes have been brought for UI compatibility.
- *
- * @author Jorg Janke
- *
* @author Ashley G Ramdass
* @date Feb 25, 2007
* @version $Revision: 0.10 $
diff --git a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/adwindow/ADTreePanel.java b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/adwindow/ADTreePanel.java
index 6b5a6ee1c6..9aa1336cc7 100644
--- a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/adwindow/ADTreePanel.java
+++ b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/adwindow/ADTreePanel.java
@@ -158,7 +158,6 @@ public class ADTreePanel extends Panel implements EventListener
{
String eventName = event.getName();
- // Elaine 2009/02/27 - expand tree
if (eventName.equals(Events.ON_CHECK) && event.getTarget() == expandToggle)
{
Clients.showBusy(null);
@@ -169,7 +168,6 @@ public class ADTreePanel extends Panel implements EventListener
expandOnCheck();
Clients.clearBusy();
}
- //
}
/**
diff --git a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/adwindow/ADWindowContent.java b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/adwindow/ADWindowContent.java
index b9e86e3dac..73df732e9e 100644
--- a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/adwindow/ADWindowContent.java
+++ b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/adwindow/ADWindowContent.java
@@ -48,9 +48,6 @@ import org.zkoss.zul.Vlayout;
/**
* Content area of {@link ADWindow}.
*
- * This class is based on org.compiere.apps.APanel written by Jorg Janke.
- * @author Jorg Janke
- *
* @author Ashley G Ramdass
* @author Low Heng Sin
* @date Feb 25, 2007
diff --git a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/adwindow/ADWindowToolbar.java b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/adwindow/ADWindowToolbar.java
index 14623b8713..56243ea73b 100644
--- a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/adwindow/ADWindowToolbar.java
+++ b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/adwindow/ADWindowToolbar.java
@@ -32,8 +32,8 @@ import org.adempiere.webui.action.Actions;
import org.adempiere.webui.action.IAction;
import org.adempiere.webui.apps.AEnv;
import org.adempiere.webui.component.Combobox;
-import org.adempiere.webui.component.FToolbar;
import org.adempiere.webui.component.Tabpanel;
+import org.adempiere.webui.component.ToolBar;
import org.adempiere.webui.component.ToolBarButton;
import org.adempiere.webui.event.ToolbarListener;
import org.adempiere.webui.part.WindowContainer;
@@ -85,7 +85,7 @@ import org.zkoss.zul.impl.LabelImageElement;
* @author Cristina Ghita, www.arhipac.ro
*
FR [ 2076330 ] Add new methods in CWindowToolbar class
*/
-public class ADWindowToolbar extends FToolbar implements EventListener
+public class ADWindowToolbar extends ToolBar implements EventListener
{
/**
* generated serial id
diff --git a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/adwindow/AbstractADWindowContent.java b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/adwindow/AbstractADWindowContent.java
index 23534bd2fb..e5b533901f 100644
--- a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/adwindow/AbstractADWindowContent.java
+++ b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/adwindow/AbstractADWindowContent.java
@@ -145,9 +145,6 @@ import org.zkoss.zul.impl.LabelImageElement;
*
* Abstract model class for the content of AD Window (toolbar+breadcrumb+tabs+statusbar).
*
- * This class is based on org.compiere.apps.APanel written by Jorg Janke.
- * @author Jorg Janke
- *
* @author Ashley G Ramdass
* @author Low Heng Sin
* @date Feb 25, 2007
@@ -175,11 +172,11 @@ public abstract class AbstractADWindowContent extends AbstractUIPart implements
*/
private static final String DETAIL_TABPANEL_SAVED_ATTR = "detail.adtabpanel.saved";
- /** onFocus event that's defer behind other event using echo **/
+ /** onFocus event that's defer behind other event using echo */
private static final String ON_FOCUS_DEFER_EVENT = "onFocusDefer";
/**
- * Event to set selected tab of detail pane. Defer behind other event using echo.
+ * Event to set selected tab of detail pane. Defer behind other event using echo.
* Event data: data[0] is tab index and data[1] is current row
*/
private static final String ON_DEFER_SET_DETAILPANE_SELECTION_EVENT = "onDeferSetDetailpaneSelection";
@@ -191,19 +188,19 @@ public abstract class AbstractADWindowContent extends AbstractUIPart implements
logger = CLogger.getCLogger(AbstractADWindowContent.class);
}
- /** Env ctx **/
+ /** Env ctx */
private Properties ctx;
- /** VO for AD Window **/
+ /** VO for AD Window */
private GridWindow gridWindow;
- /** status bar for message and record info **/
+ /** status bar for message and record info */
protected StatusBar statusBar;
- /** UI part for AD_Tabs **/
+ /** UI part for AD_Tabs */
protected IADTabbox adTabbox;
- /** register window (desktop tab) no **/
+ /** register window (desktop tab) no */
private int curWindowNo;
/**
@@ -221,25 +218,25 @@ public abstract class AbstractADWindowContent extends AbstractUIPart implements
*/
private int m_onlyCurrentDays = 0;
- /** true if find window cancel by user **/
+ /** true if find window cancel by user */
private boolean m_findCancelled;
- /** true if user press new button at find window **/
+ /** true if user press new button at find window */
private boolean m_findCreateNew;
- /** true when initial query for first tab is running **/
+ /** true when initial query for first tab is running */
private boolean m_queryInitiating;
- /** path to selected tab **/
+ /** path to selected tab */
protected BreadCrumb breadCrumb;
- /** AD_Window.AD_Window_ID **/
+ /** AD_Window.AD_Window_ID */
private int adWindowId;
- /** image for window title **/
+ /** image for window title */
private MImage image;
- /** delete confirmation logic for selected tab **/
+ /** delete confirmation logic for selected tab */
private String deleteConfirmationLogic;
/**
@@ -252,7 +249,7 @@ public abstract class AbstractADWindowContent extends AbstractUIPart implements
*/
protected ArrayList quickFormOpenTabs = new ArrayList ();
- /** track last focus field editor component **/
+ /** track last focus field editor component */
protected Component lastFocusEditor = null;
/**
@@ -811,10 +808,9 @@ public abstract class AbstractADWindowContent extends AbstractUIPart implements
/**
* Show initial find window for first tab (if necessary)
*
- * @param query
- * initial query
- * @param mTab
- * tab
+ * @param query initial query
+ * @param mTab tab
+ * @param callback callback for query to apply, must not be null
* @return query or null
*/
private void initialQuery(final MQuery query, GridTab mTab, final Callback callback)
@@ -952,7 +948,8 @@ public abstract class AbstractADWindowContent extends AbstractUIPart implements
}
/**
- * Delegate to {@link BreadCrumbLink} ON_Click event
+ * Navigate to parent record.
+ * Delegate to {@link BreadCrumbLink} ON_Click event.
* @see ToolbarListener#onParentRecord()
*/
@Override
@@ -1071,7 +1068,7 @@ public abstract class AbstractADWindowContent extends AbstractUIPart implements
protected ADWindow adwindow;
- //true if confirmation for exit dialog is visible
+ /** true if confirmation for exit dialog is visible */
protected boolean showingOnExitDialog;
/**
@@ -1217,7 +1214,7 @@ public abstract class AbstractADWindowContent extends AbstractUIPart implements
}
/**
- * handle post it event
+ * Open Post It note dialog.
*/
public void onPostIt()
{
@@ -1506,7 +1503,7 @@ public abstract class AbstractADWindowContent extends AbstractUIPart implements
* Change active tab to newTabIndex.
* Delegate to {@link #setActiveTab0(int, int, Callback)}
* @param newTabIndex
- * @param callback
+ * @param callback optional callback
*/
private void setActiveTab(final int newTabIndex, final Callback callback) {
@@ -1545,7 +1542,7 @@ public abstract class AbstractADWindowContent extends AbstractUIPart implements
/**
* save (if needed) and execute callback
- * @param callback
+ * @param callback callback for result of execution, must not be null
*/
public void saveAndNavigate(final Callback callback) {
if (adTabbox != null)
@@ -1581,7 +1578,7 @@ public abstract class AbstractADWindowContent extends AbstractUIPart implements
* Change selected tab from oldTabIndex to newTabIndex
* @param oldTabIndex
* @param newTabIndex
- * @param callback
+ * @param callback optional callback for result of execution
*/
private void setActiveTab0(int oldTabIndex, int newTabIndex,
final Callback callback) {
@@ -2128,7 +2125,7 @@ public abstract class AbstractADWindowContent extends AbstractUIPart implements
/**
* Auto save current changes (if auto save is enable).
* Delegate to {@link #asyncAutoSave()}
- * @param e
+ * @param e DataStatusEvent
*/
private synchronized void autoSaveChanges(DataStatusEvent e) {
if (!e.isInitEdit() && toolbar.isSaveEnable() && MSysConfig.getBooleanValue(MSysConfig.ZK_AUTO_SAVE_CHANGES, false, Env.getAD_Client_ID(Env.getCtx()))) {
@@ -2198,7 +2195,7 @@ public abstract class AbstractADWindowContent extends AbstractUIPart implements
* Refresh all row.
* Delegate to {@link #doOnRefresh(boolean)}
* @param fireEvent
- * @param saveCurrentRow
+ * @param saveCurrentRow if true, save before refresh
*/
public void onRefresh(final boolean fireEvent, final boolean saveCurrentRow)
{
@@ -2785,7 +2782,7 @@ public abstract class AbstractADWindowContent extends AbstractUIPart implements
* @param navigationEvent
* @param newRecord
* @param wasChanged
- * @param callback
+ * @param callback optional callback for result of save
*/
private void onSave0(boolean onSaveEvent, boolean navigationEvent,
boolean newRecord, boolean wasChanged, Callback callback) {
@@ -2922,7 +2919,8 @@ public abstract class AbstractADWindowContent extends AbstractUIPart implements
}
/**
- * Delegate to {@link #onSave(boolean, boolean, Callback)}
+ * Save and create new record.
+ * Delegate to {@link #onSave(boolean, boolean, Callback)}.
* @see ToolbarListener#onSaveCreate()
*/
@Override
@@ -3174,7 +3172,6 @@ public abstract class AbstractADWindowContent extends AbstractUIPart implements
postCallback.onCallback(false);
}
}
- //
/**
* Delegate to {@link #onPrintCallback(Callback)}
@@ -3212,9 +3209,8 @@ public abstract class AbstractADWindowContent extends AbstractUIPart implements
private void onPrintCallback(final Callback postCallback) {
//Get process defined for this tab
final int AD_Process_ID = adTabbox.getSelectedGridTab().getAD_Process_ID();
- //log.info("ID=" + AD_Process_ID);
- // No report defined
+ // No document print process defined
if (AD_Process_ID == 0)
{
onReport();
@@ -3231,7 +3227,6 @@ public abstract class AbstractADWindowContent extends AbstractUIPart implements
final ProcessModalDialog dialog = new ProcessModalDialog(AbstractADWindowContent.this, getWindowNo(), AD_Process_ID,table_ID, record_ID, true);
if (dialog.isValid()) {
- //dialog.setWidth("500px");
dialog.setBorder("normal");
getComponent().getParent().appendChild(dialog);
showBusyMask(dialog);
@@ -3323,7 +3318,6 @@ public abstract class AbstractADWindowContent extends AbstractUIPart implements
}
}
- // Elaine 2008/07/17
/**
* @see ToolbarListener#onActiveWorkflows()
*/
@@ -3344,7 +3338,7 @@ public abstract class AbstractADWindowContent extends AbstractUIPart implements
}
}
}
- //
+
/**
* Close popup for toolbar button
* @param btnName toobar button name
@@ -3377,9 +3371,7 @@ public abstract class AbstractADWindowContent extends AbstractUIPart implements
new WRequest(toolbar.getToolbarItem("Requests"), adTabbox.getSelectedGridTab().getAD_Table_ID(), adTabbox.getSelectedGridTab().getRecord_ID(), C_BPartner_ID);
}
}
- //
-
- // Elaine 2008/07/22
+
/**
* @see ToolbarListener#onProductInfo()
*/
@@ -3389,10 +3381,7 @@ public abstract class AbstractADWindowContent extends AbstractUIPart implements
closeToolbarPopup("ProductInfo");
InfoPanel.showPanel(I_M_Product.Table_Name);
}
- //
-
-
- // Elaine 2008/07/28
+
/**
* Delegate to {@link WArchive}
* @see ToolbarListener#onArchive()
@@ -3409,7 +3398,6 @@ public abstract class AbstractADWindowContent extends AbstractUIPart implements
}
}
- //
/**
* Delegate to {@link ExportAction}
*/
@@ -3508,7 +3496,7 @@ public abstract class AbstractADWindowContent extends AbstractUIPart implements
getCurrentFindWindow().dispose();
}
- /**************************************************************************
+ /**
* Execute action for button.
* With the exception of zoom to record_id, delegate to {@link #actionButton0(String, IProcessButton)}.
* @param wButton {@link IProcessButton}
@@ -3568,7 +3556,7 @@ public abstract class AbstractADWindowContent extends AbstractUIPart implements
}
}
- /**************************************************************************
+ /**
* Execution action of button.
* Delegate to {@link #executeButtonProcess(IProcessButton, boolean, int, int, boolean)} for process
* @param col column name
@@ -3998,7 +3986,6 @@ public abstract class AbstractADWindowContent extends AbstractUIPart implements
if (dialog.isValid())
{
- //dialog.setWidth("500px");
dialog.setBorder("normal");
getComponent().getParent().appendChild(dialog);
if (ClientInfo.isMobile())
@@ -4109,14 +4096,8 @@ public abstract class AbstractADWindowContent extends AbstractUIPart implements
template.run();
}
- /**************************************************************************
- * Process Callout(s).
- *
- * The Callout is in the string of
- * "class.method;class.method;"
- * If there is no class name, i.e. only a method name, the class is regarded
- * as CalloutSystem.
- * The class needs to comply with the Interface Callout.
+ /**
+ * Process Callout(s).
*
* @param field field
* @return error message or ""
@@ -4374,7 +4355,7 @@ public abstract class AbstractADWindowContent extends AbstractUIPart implements
}
/**
- *
+ * Get cache find window for current selected tab
* @return {@link FindWindow}
*/
public FindWindow getCurrentFindWindow() {
diff --git a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/adwindow/CompositeADTabbox.java b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/adwindow/CompositeADTabbox.java
index 59e4fb1eaa..06fb157dfe 100644
--- a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/adwindow/CompositeADTabbox.java
+++ b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/adwindow/CompositeADTabbox.java
@@ -27,6 +27,7 @@ import org.adempiere.util.Callback;
import org.adempiere.webui.adwindow.DetailPane.Tabpanel;
import org.adempiere.webui.component.ADTabListModel;
import org.adempiere.webui.component.ADTabListModel.ADTabLabel;
+import org.adempiere.webui.component.Tabbox;
import org.adempiere.webui.util.ZKUpdateUtil;
import org.adempiere.webui.window.Dialog;
import org.compiere.model.DataStatusEvent;
@@ -56,8 +57,8 @@ import org.zkoss.zul.Vlayout;
/**
* Header and detail UI for AD_Tabs.
- * This class manage a list of tabs with the current selected tab as the attached and visible {@link ADTabpanel} instance.
- * Child tabs of selected tab is shown in {@link DetailPane} inside {@link ADTabpanel}.
+ * This class manage a list of tabs with the current selected tab as the visible {@link ADTabpanel} instance.
+ * Child tabs of selected tab is shown in {@link DetailPane} using {@link Tabbox}.
*
* @author Ashley G Ramdass
* @author Low Heng Sin
diff --git a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/adwindow/GridTabRowRenderer.java b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/adwindow/GridTabRowRenderer.java
index e54520b1b6..717e15a21c 100644
--- a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/adwindow/GridTabRowRenderer.java
+++ b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/adwindow/GridTabRowRenderer.java
@@ -310,9 +310,10 @@ public class GridTabRowRenderer implements RowRenderer, RowRendererExt
}
/**
- * get component to display value of a field.
- * when display is boolean or button, return correspond component
- * other return a label with text get from {@link #getDisplayText(Object, GridField, int, boolean)}
+ * Get component to display value of a field.
+ * When display type is boolean or button, return corresponding component.
+ * Otherwise, use Label or Component from {@link WEditor#getDisplayComponent()} to display text from {@link #getDisplayText(Object, GridField, int, boolean)}
+ * (As it is, only {@link Html} is supported for {@link WEditor#getDisplayComponent()}).
* @param rowIndex
* @param value
* @param gridField
@@ -347,7 +348,7 @@ public class GridTabRowRenderer implements RowRenderer, RowRendererExt
if (component instanceof Html){
((Html)component).setContent(text);
}else{
- throw new UnsupportedOperationException("neet a componet has setvalue function");
+ throw new UnsupportedOperationException("Only implemented for Html component.");
}
}
}
diff --git a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/adwindow/GridView.java b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/adwindow/GridView.java
index 8892af9ce9..7e635f4312 100644
--- a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/adwindow/GridView.java
+++ b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/adwindow/GridView.java
@@ -134,8 +134,8 @@ public class GridView extends Vlayout implements EventListener, IdSpace,
private int pageSize = DEFAULT_PAGE_SIZE;
/**
- * list field display in grid mode, in case user customize grid
- * this list container only display list.
+ * fields display in grid mode, in case user customize grid,
+ * this list include only display fields.
*/
private GridField[] gridFields;
diff --git a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/apps/AbstractProcessDialog.java b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/apps/AbstractProcessDialog.java
index 3990bf751e..2485f61069 100644
--- a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/apps/AbstractProcessDialog.java
+++ b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/apps/AbstractProcessDialog.java
@@ -128,7 +128,7 @@ public abstract class AbstractProcessDialog extends Window implements IProcessUI
private ProcessInfo m_pi = null;
/** if true, auto call {@link #dispose()} in {@link #ON_COMPLETE_EVENT} handler. **/
private boolean m_disposeOnComplete;
- /** Panel for process paramters **/
+ /** Panel for process parameters **/
private ProcessParameterPanel parameterPanel = null;
/** Checkbox to toggle running process/report as background job **/
private Checkbox runAsJobField = null;
@@ -181,7 +181,7 @@ public abstract class AbstractProcessDialog extends Window implements IProcessUI
* @param pi
* @param autoStart
* @param isDisposeOnComplete
- * @return
+ * @return true if init is ok.
*/
protected boolean init(Properties ctx, int WindowNo, int AD_Process_ID, ProcessInfo pi, boolean autoStart, boolean isDisposeOnComplete)
{
diff --git a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/apps/form/WPluginManager.java b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/apps/form/WPluginManager.java
index b9a74abfcb..6552295f40 100644
--- a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/apps/form/WPluginManager.java
+++ b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/apps/form/WPluginManager.java
@@ -139,7 +139,6 @@ public class WPluginManager extends ADForm implements EventListener {
ZKUpdateUtil.setVflex(pluginsTable, "1");
ZKUpdateUtil.setHflex(pluginsTable, "1");
refreshPluginTable();
- pluginsTable.autoSize();
pluginsTable.addEventListener(Events.ON_SELECT, this);
pluginActions = new Listbox(new KeyNamePair[] { new KeyNamePair(PLUGIN_ACTION_NONE, ""),
diff --git a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/apps/graph/WDocumentStatusIndicator.java b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/apps/graph/WDocumentStatusIndicator.java
index c0d83a5b9f..48b3601223 100644
--- a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/apps/graph/WDocumentStatusIndicator.java
+++ b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/apps/graph/WDocumentStatusIndicator.java
@@ -96,7 +96,7 @@ public class WDocumentStatusIndicator extends Panel implements EventListener list = new ArrayList();
+ protected ArrayList list = new ArrayList();
private boolean m_chartSelection;
@@ -104,7 +104,7 @@ public class WGraph extends Div implements IdSpace {
private String m_yAxisLabel;
- public DecimalFormat format = DisplayType.getNumberFormat(DisplayType.Amount);
+ protected DecimalFormat format = DisplayType.getNumberFormat(DisplayType.Amount);
/**
* Constructor
@@ -219,6 +219,9 @@ public class WGraph extends Div implements IdSpace {
}
}
+ /**
+ * Load MMeasure data for {@link #m_goal}.
+ */
private void loadData() {
// Calculated
MMeasure measure = m_goal.getMeasure();
@@ -256,6 +259,10 @@ public class WGraph extends Div implements IdSpace {
}
} // loadData
+ /**
+ * Render chart to {@link #panel}.
+ * @param type optional chart type. if null, fallback to m_goal.getChartType
+ */
private void renderChart(String type) {
int width = 560;
int height = 400;
@@ -398,6 +405,10 @@ public class WGraph extends Div implements IdSpace {
return array;
}
+ /**
+ * Render {@link #m_goal} data in html table.
+ * @param parent
+ */
private void renderTable(Component parent) {
Div div = new Div();
appendChild(div);
diff --git a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/apps/graph/WPAPanel.java b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/apps/graph/WPAPanel.java
index c0699f7955..dd202fcece 100644
--- a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/apps/graph/WPAPanel.java
+++ b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/apps/graph/WPAPanel.java
@@ -45,6 +45,9 @@ import org.zkoss.zk.ui.event.Events;
import org.zkoss.zul.Div;
import org.zkoss.zul.Label;
+/**
+ * Panel with one or more {@link WPerformanceIndicator}
+ */
public class WPAPanel extends Panel implements EventListener
{
/**
@@ -53,7 +56,10 @@ public class WPAPanel extends Panel implements EventListener
private static final long serialVersionUID = -6367672112341229048L;
/**
- * Load Performance Goals for current login user
+ * Load Performance Goals for current login user.
+ * For asynchronous use case, load MGoal[] through this method in non event listener thread
+ * and call {@link #setGoals(MGoal[], Options)} in event listener thread to update UI. To
+ * keep UI responsive, we need to avoid running long operation in event listener thread.
* @return MGoal[]
*/
public static MGoal[] loadGoal()
@@ -136,7 +142,7 @@ public class WPAPanel extends Panel implements EventListener
} // init
/**
- * Event Listener for Drill Down
+ * Open {@link WPerformanceDetail}
* @param e event
*/
@Override
diff --git a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/apps/graph/WPAWidget.java b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/apps/graph/WPAWidget.java
index 24cbde6fb3..bcc5b16414 100644
--- a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/apps/graph/WPAWidget.java
+++ b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/apps/graph/WPAWidget.java
@@ -33,15 +33,20 @@ import org.zkoss.zk.ui.event.Events;
import org.zkoss.zul.Div;
import org.zkoss.zul.Label;
+/**
+ * Dashboard gadget panel for individual {@link WPerformanceIndicator}
+ */
public class WPAWidget extends Panel {
/**
- *
+ * generated serial id
*/
private static final long serialVersionUID = 5684412399657327777L;
- /**************************************************************************
- * Constructor
+ /**
+ * @param goal
+ * @param options
+ * @param isShowTitle
*/
public WPAWidget (MGoal goal, Options options, boolean isShowTitle)
{
@@ -51,7 +56,7 @@ public class WPAWidget extends Panel {
}
/**
- * Static/Dynamic Init
+ * Render panel
* @param goal
* @param options
*/
diff --git a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/apps/graph/WPerformanceDetail.java b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/apps/graph/WPerformanceDetail.java
index c327e9ede2..a0fb3f903d 100644
--- a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/apps/graph/WPerformanceDetail.java
+++ b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/apps/graph/WPerformanceDetail.java
@@ -5,8 +5,7 @@ import org.adempiere.webui.session.SessionManager;
import org.compiere.model.MGoal;
/**
- * Performance Detail Frame.
- * BarPanel for Drill-Down
+ * Window with Chart and Details for {@link MGoal}
*
* @author Jorg Janke
* @version $Id: PerformanceDetail.java,v 1.2 2006/07/30 00:51:28 jjanke Exp $
@@ -14,13 +13,13 @@ import org.compiere.model.MGoal;
public class WPerformanceDetail extends Window
{
/**
- *
+ * generated serial id
*/
private static final long serialVersionUID = 3460594735973451874L;
/**
* Constructor.
- * Called from PAPanel, ViewPI (Performance Indicator)
+ * Called from {@link WPAPanel} and {@link WPAWidget}
* @param goal goal
*/
public WPerformanceDetail (MGoal goal)
@@ -28,12 +27,12 @@ public class WPerformanceDetail extends Window
super();
setTitle(goal.getName());
- WGraph barPanel = new WGraph(goal, 0, true, false, true, true);
- appendChild(barPanel);
+ WGraph graph = new WGraph(goal, 0, true, false, true, true);
+ appendChild(graph);
this.setAttribute(Window.MODE_KEY, Window.MODE_EMBEDDED);
this.setStyle("height: 100%; width: 100%; position: absolute; overflow: auto");
- barPanel.setStyle("height: 100%; width: 100%; position: absolute; overflow: visible");
+ graph.setStyle("height: 100%; width: 100%; position: absolute; overflow: visible");
SessionManager.getAppDesktop().showWindow(this);
} // PerformanceDetail
}
diff --git a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/apps/graph/WPerformanceIndicator.java b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/apps/graph/WPerformanceIndicator.java
index fb55d01fbe..bb696bf6dd 100644
--- a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/apps/graph/WPerformanceIndicator.java
+++ b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/apps/graph/WPerformanceIndicator.java
@@ -36,7 +36,7 @@ import org.zkoss.zul.Menuitem;
import org.zkoss.zul.Menupopup;
/**
- * Performance Indicator
+ * Panel with chart for {@link MGoal}
*
* @author hengsin
*/
diff --git a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/apps/graph/WViewPI.java b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/apps/graph/WViewPI.java
index e9c2592e96..28e88d5886 100644
--- a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/apps/graph/WViewPI.java
+++ b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/apps/graph/WViewPI.java
@@ -3,11 +3,14 @@ package org.adempiere.webui.apps.graph;
import org.adempiere.webui.panel.ADForm;
import org.compiere.model.MGoal;
+/**
+ * Form for {@link WPAPanel}
+ */
@org.idempiere.ui.zk.annotation.Form(name = "org.adempiere.apps.graph.ViewPI")
public class WViewPI extends ADForm {
/**
- *
+ * generated serial id
*/
private static final long serialVersionUID = -755873621984745607L;
diff --git a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/apps/graph/jfreegraph/ChartRenderer.java b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/apps/graph/jfreegraph/ChartRenderer.java
index 4015520e8d..24dd3b9f33 100644
--- a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/apps/graph/jfreegraph/ChartRenderer.java
+++ b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/apps/graph/jfreegraph/ChartRenderer.java
@@ -32,8 +32,9 @@ import org.zkoss.zul.Imagemap;
/**
* @author Paul Bowden, Adaxa Pty Ltd
* @author hengsin
- *
+ * @deprecated replace by billboard based implementation
*/
+@Deprecated
/* package */ class ChartRenderer {
private static final CLogger log = CLogger.getCLogger(ChartRenderer.class);
diff --git a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/apps/graph/jfreegraph/ChartRendererServiceImpl.java b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/apps/graph/jfreegraph/ChartRendererServiceImpl.java
index 44299c0e10..9654a86161 100644
--- a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/apps/graph/jfreegraph/ChartRendererServiceImpl.java
+++ b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/apps/graph/jfreegraph/ChartRendererServiceImpl.java
@@ -46,8 +46,9 @@ import org.zkoss.zul.Imagemap;
/**
*
* @author hengsin
- *
+ * @deprecated replace by billboard based implementation
*/
+@Deprecated
public class ChartRendererServiceImpl implements IChartRendererService {
private final static CLogger log = CLogger.getCLogger(ChartRendererServiceImpl.class);
diff --git a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/apps/graph/jfreegraph/PerformanceGraphBuilder.java b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/apps/graph/jfreegraph/PerformanceGraphBuilder.java
index 6652c27b08..c80c356350 100644
--- a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/apps/graph/jfreegraph/PerformanceGraphBuilder.java
+++ b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/apps/graph/jfreegraph/PerformanceGraphBuilder.java
@@ -31,8 +31,9 @@ import org.jfree.data.general.DefaultValueDataset;
/**
*
* @author hengsin
- *
+ * @deprecated replace by billboard based implementation
*/
+@Deprecated
public class PerformanceGraphBuilder {
public JFreeChart createIndicatorChart(IndicatorModel model)
diff --git a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/apps/graph/model/ChartModel.java b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/apps/graph/model/ChartModel.java
index 25e0db13f4..5e22d972f4 100644
--- a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/apps/graph/model/ChartModel.java
+++ b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/apps/graph/model/ChartModel.java
@@ -16,9 +16,8 @@ package org.adempiere.webui.apps.graph.model;
import org.compiere.model.MChart;
/**
- *
+ * Model for chart (AD_Chart)
* @author hengsin
- *
*/
public class ChartModel {
public MChart chart;
diff --git a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/apps/graph/model/GoalModel.java b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/apps/graph/model/GoalModel.java
index 42d31a4206..5834585e0f 100644
--- a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/apps/graph/model/GoalModel.java
+++ b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/apps/graph/model/GoalModel.java
@@ -19,9 +19,8 @@ import org.adempiere.apps.graph.GraphColumn;
import org.compiere.model.MGoal;
/**
- *
+ * Model for performance graph (PA_Goal)
* @author hengsin
- *
*/
public class GoalModel {
public MGoal goal;
diff --git a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/apps/graph/model/IndicatorModel.java b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/apps/graph/model/IndicatorModel.java
index 5da0fa1812..050ca5f816 100644
--- a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/apps/graph/model/IndicatorModel.java
+++ b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/apps/graph/model/IndicatorModel.java
@@ -18,9 +18,8 @@ import java.awt.Color;
import org.compiere.model.MGoal;
/**
- *
+ * Model for performance indicator (meter/gauge)
* @author hengsin
- *
*/
public class IndicatorModel {
public MGoal goalModel;
diff --git a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/apps/wf/WFEditor.java b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/apps/wf/WFEditor.java
index 3425ae760f..1e55ab52f5 100644
--- a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/apps/wf/WFEditor.java
+++ b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/apps/wf/WFEditor.java
@@ -66,27 +66,32 @@ import org.zkoss.zul.Toolbarbutton;
import org.zkoss.zul.Vbox;
/**
- *
+ * Workflow editor form
* @author Low Heng Sin
- *
*/
@org.idempiere.ui.zk.annotation.Form(name = "org.compiere.apps.wf.WFPanel")
public class WFEditor extends ADForm {
/**
- *
+ * generated serial id
*/
private static final long serialVersionUID = 4293422396394778274L;
+ /** Workflows dropdown list */
private Listbox workflowList;
private int m_workflowId = 0;
private Toolbarbutton zoomButton;
private Toolbarbutton refreshButton;
private Toolbarbutton newButton;
+ /** Content of {@link #center} */
private Table table;
+ /** Center of form */
private Center center;
private MWorkflow m_wf;
private WFNodeContainer nodeContainer;
+ /**
+ * Layout form
+ */
@Override
protected void initForm() {
ZKUpdateUtil.setHeight(this, "100%");
@@ -159,6 +164,9 @@ public class WFEditor extends ADForm {
ZKUpdateUtil.setHeight(south, "36px");
}
+ /**
+ * Create {@link #table}
+ */
private void createTable() {
table = new Table();
table.setDynamicProperty("cellpadding", "0");
@@ -219,6 +227,9 @@ public class WFEditor extends ADForm {
}
}
+ /**
+ * Create new workflow node
+ */
private void createNewNode() {
String nameLabel = Msg.getElement(Env.getCtx(), MWFNode.COLUMNNAME_Name);
String title = Msg.getMsg(Env.getCtx(), "CreateNewNode");
@@ -268,6 +279,11 @@ public class WFEditor extends ADForm {
w.doHighlighted();
}
+ /**
+ * reload and re-render workflow nodes
+ * @param workflowId
+ * @param reread
+ */
protected void reload(int workflowId, boolean reread) {
center.removeChild(table);
createTable();
@@ -275,6 +291,11 @@ public class WFEditor extends ADForm {
load(workflowId, reread);
}
+ /**
+ * Load and render workflow nodes
+ * @param workflowId
+ * @param reread
+ */
private void load(int workflowId, boolean reread) {
// Get Workflow
m_wf = MWorkflow.getCopy(Env.getCtx(), workflowId, (String)null);
@@ -382,6 +403,10 @@ public class WFEditor extends ADForm {
}
+ /**
+ * Show popup menu for workflow node
+ * @param target
+ */
protected void showNodeMenu(Component target) {
Integer AD_WF_Node_ID = (Integer) target.getAttribute("AD_WF_Node_ID");
if (AD_WF_Node_ID != null) {
@@ -453,7 +478,7 @@ public class WFEditor extends ADForm {
}
/**
- * Zoom to WorkFlow
+ * Zoom to WorkFlow window
*/
private void zoom()
{
@@ -463,9 +488,11 @@ public class WFEditor extends ADForm {
} // zoom
/**
- * Add Menu Item to - add new line to node
- * @param menu base menu
- * @param title title
+ * Menu item to add line to next node or to apply actions (delete, properties or zoom) to source workflow node.
+ * @param menu popup menu
+ * @param title title
+ * @param node source workflow node
+ * @param AD_WF_NodeTo_ID if > 0, next workflow node id. if < 0, actions to apply to node
*/
private void addMenuItem (Menupopup menu, String title, MWFNode node, int AD_WF_NodeTo_ID)
{
@@ -475,9 +502,10 @@ public class WFEditor extends ADForm {
} // addMenuItem
/**
- * Add Menu Item to - delete line
- * @param menu base menu
- * @param title title
+ * Add Menu Item to - delete line
+ * @param menu popup menu
+ * @param title title
+ * @param line
*/
private void addMenuItem (Menupopup menu, String title, MWFNodeNext line)
{
diff --git a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/apps/wf/WFPopupItem.java b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/apps/wf/WFPopupItem.java
index f4f42fd53f..916a4e07f5 100644
--- a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/apps/wf/WFPopupItem.java
+++ b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/apps/wf/WFPopupItem.java
@@ -1,5 +1,31 @@
+/***********************************************************************
+ * This file is part of iDempiere ERP Open Source *
+ * http://www.idempiere.org *
+ * *
+ * Copyright (C) Contributors *
+ * *
+ * This program is free software; you can redistribute it and/or *
+ * modify it under the terms of the GNU General Public License *
+ * as published by the Free Software Foundation; either version 2 *
+ * of the License, or (at your option) any later version. *
+ * *
+ * This program is distributed in the hope that it will be useful, *
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of *
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
+ * GNU General Public License for more details. *
+ * *
+ * You should have received a copy of the GNU General Public License *
+ * along with this program; if not, write to the Free Software *
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, *
+ * MA 02110-1301, USA. *
+ * *
+ * Contributors: *
+ * - hengsin *
+ **********************************************************************/
package org.adempiere.webui.apps.wf;
+import java.util.logging.Level;
+
import org.adempiere.webui.apps.AEnv;
import org.adempiere.webui.component.ConfirmPanel;
import org.adempiere.webui.component.Textbox;
@@ -26,10 +52,12 @@ import org.zkoss.zul.Vbox;
public class WFPopupItem extends Menuitem {
/**
- *
+ * generated serial id
*/
private static final long serialVersionUID = -8409752634782368108L;
+ /** Node actions */
+
public static final int WFPOPUPITEM_DELETENODE = -1;
public static final int WFPOPUPITEM_PROPERTIES = -2;
public static final int WFPOPUPITEM_ZOOM = -3;
@@ -41,8 +69,8 @@ public class WFPopupItem extends Menuitem {
/**
* Add Line Item
* @param title title
- * @param node node
- * @param AD_WF_NodeTo_ID line to
+ * @param node workflow node
+ * @param AD_WF_NodeTo_ID if > 0, next workflow node id. if < 0, actions to apply to node
*/
public WFPopupItem (String title, MWFNode node, int AD_WF_NodeTo_ID)
{
@@ -64,15 +92,20 @@ public class WFPopupItem extends Menuitem {
m_AD_Workflow_ID = line.getAD_WF_Node().getAD_Workflow_ID();
} // WFPopupItem
- /** The Node */
- private MWFNode m_node;
- /** The Line */
+ /** Source Workfklow Node */
+ private MWFNode m_node;
+ /** The Line to delete (if {@link #m_AD_WF_NodeTo_ID} = 0) */
private MWFNodeNext m_line;
- /** The Next Node ID */
+ /**
+ *
> 0 - next workflow node id
+ *
< 0 - actions to apply to {@link #m_node}
+ *
0 - to delete {@link #m_node}
+ */
private int m_AD_WF_NodeTo_ID;
/**
- * Execute
+ * Execute action for menu item
+ * @param wfp WFEditor
*/
public void execute(final WFEditor wfp)
{
@@ -86,7 +119,8 @@ public class WFPopupItem extends Menuitem {
if (AD_Client_ID > 11)
newLine.setEntityType(MSysConfig.getValue(MSysConfig.DEFAULT_ENTITYTYPE, MEntityType.ENTITYTYPE_UserMaintained));
newLine.saveEx();
- log.info("Add Line to " + m_node + " -> " + newLine);
+ if (log.isLoggable(Level.INFO))
+ log.info("Add Line to " + m_node + " -> " + newLine);
wfp.reload(m_AD_Workflow_ID, true);
}
// Edit Properties
@@ -112,14 +146,16 @@ public class WFPopupItem extends Menuitem {
// Delete Node
else if (m_node != null && m_AD_WF_NodeTo_ID == WFPOPUPITEM_DELETENODE)
{
- log.info("Delete Node: " + m_node);
+ if (log.isLoggable(Level.INFO))
+ log.info("Delete Node: " + m_node);
m_node.delete(false);
wfp.reload(m_AD_Workflow_ID, true);
}
// Delete Line
else if (m_line != null)
{
- log.info("Delete Line: " + m_line);
+ if (log.isLoggable(Level.INFO))
+ log.info("Delete Line: " + m_line);
m_line.delete(false);
wfp.reload(m_AD_Workflow_ID, true);
}
@@ -127,6 +163,10 @@ public class WFPopupItem extends Menuitem {
log.warning("No Action??");
} // execute
+ /**
+ * Edit node properties
+ * @param wfp WFEditor
+ */
private void editNode(final WFEditor wfp) {
String title = Msg.getMsg(Env.getCtx(), "Properties");
final Window w = new Window();
diff --git a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/apps/wf/WWFActivity.java b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/apps/wf/WWFActivity.java
index 97e33aebbe..763722a1d1 100644
--- a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/apps/wf/WWFActivity.java
+++ b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/apps/wf/WWFActivity.java
@@ -77,7 +77,7 @@ import org.zkoss.zul.South;
import org.zkoss.zul.Vlayout;
/**
- * Direct port from WFActivity
+ * Workflow activity form
* @author hengsin
*
*/
@@ -85,7 +85,7 @@ import org.zkoss.zul.Vlayout;
public class WWFActivity extends ADForm implements EventListener
{
/**
- *
+ * generated serial id
*/
private static final long serialVersionUID = -1658595186719510159L;
/** Window No */
@@ -127,12 +127,19 @@ public class WWFActivity extends ADForm implements EventListener
private WListbox listbox = new WListbox();
private final static String HISTORY_DIV_START_TAG = "
";
+
+ /**
+ * default constructor
+ */
public WWFActivity()
{
super();
LayoutUtils.addSclass("workflow-activity-form", this);
}
+ /**
+ * Load activities and layout form
+ */
protected void initForm()
{
loadActivities();
@@ -161,12 +168,20 @@ public class WWFActivity extends ADForm implements EventListener
display(-1);
}
+ /**
+ * set tooltip text of btn
+ * @param btn
+ * @param key AD_Message key
+ */
private void setTooltipText(Button btn, String key) {
String text = Util.cleanAmp(Msg.translate(Env.getCtx(), key));
if (!Util.isEmpty(text, true))
btn.setTooltiptext(text);
}
+ /**
+ * Layout form
+ */
private void init()
{
Grid grid = new Grid();
@@ -303,6 +318,7 @@ public class WWFActivity extends ADForm implements EventListener
this.setStyle("height: 100%; width: 100%; position: relative;");
}
+ @Override
public void onEvent(Event event) throws Exception
{
Component comp = event.getTarget();
@@ -342,7 +358,7 @@ public class WWFActivity extends ADForm implements EventListener
/**
* Get active activities count
- * @return int
+ * @return pending activities count
*/
public int getActivitiesCount()
{
@@ -357,7 +373,7 @@ public class WWFActivity extends ADForm implements EventListener
/**
* Load Activities
- * @return int
+ * @return number of activities loaded
*/
public int loadActivities()
{
@@ -422,7 +438,7 @@ public class WWFActivity extends ADForm implements EventListener
} // loadActivities
/**
- * Reset Display
+ * Reset form and return activity at selIndex
* @param selIndex select index
* @return selected activity
*/
@@ -464,8 +480,8 @@ public class WWFActivity extends ADForm implements EventListener
} // resetDisplay
/**
- * Display.
- * Fill Editors
+ * Display activity at index
+ * @param index
*/
public void display (int index)
{
@@ -537,7 +553,7 @@ public class WWFActivity extends ADForm implements EventListener
/**
- * Zoom
+ * Zoom to workflow activity window
*/
private void cmd_zoom()
{
@@ -548,7 +564,7 @@ public class WWFActivity extends ADForm implements EventListener
} // cmd_zoom
/**
- * Answer Button
+ * Action Button
*/
private void cmd_button()
{
@@ -565,8 +581,9 @@ public class WWFActivity extends ADForm implements EventListener
MQuery query = MQuery.getEqualQuery(ColumnName, Record_ID);
boolean IsSOTrx = m_activity.isSOTrx();
//
- log.info("Zoom to AD_Window_ID=" + AD_Window_ID
- + " - " + query + " (IsSOTrx=" + IsSOTrx + ")");
+ if (log.isLoggable(Level.INFO))
+ log.info("Zoom to AD_Window_ID=" + AD_Window_ID
+ + " - " + query + " (IsSOTrx=" + IsSOTrx + ")");
AEnv.zoom(AD_Window_ID, query);
}
diff --git a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/component/ADTabListModel.java b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/component/ADTabListModel.java
index 52bdd7aa6b..c3a3707047 100644
--- a/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/component/ADTabListModel.java
+++ b/org.adempiere.ui.zk/WEB-INF/src/org/adempiere/webui/component/ADTabListModel.java
@@ -22,29 +22,42 @@ import org.zkoss.zul.Listitem;
import org.zkoss.zul.ListitemRenderer;
import org.zkoss.zul.ListitemRendererExt;
+/**
+ * List model and List item renderer implementation for list of AD_Tab label.
+ * ADTabLabel class aside, this is not use any more.
+ */
public class ADTabListModel extends AbstractListModel