General HandlerExtension stuff

DashboardHandlerExtension

Tip

Any extension that implements DashboardHandlerExtension will watch all events fired by the Dashboard.

Methods

method	Description
onChange(DashboardEventConstant event)	Each time there is a new dashboard event, the onChange method will be fired by OpenKM.

Sample

package com.openkm.extension.frontend.client;

import com.google.gwt.user.client.Window;
import com.openkm.frontend.client.extension.event.HasDashboardEvent.DashboardEventConstant;
import com.openkm.frontend.client.extension.event.handler.DashboardHandlerExtension;

public class HandlerTest implements DashboardHandlerExtension {

    @Override
    public void onChange(DashboardEventConstant event) {
        Window.alert("dashboard event fired");
    }

}

LanguageHandlerExtension

Tip

Any extension that implements LanguageHandlerExtension will watch all events related to language changes.

 Methods

method	Description
onChange(LanguageEventConstant event)	Each time there is a new language event, the onChange method will be fired by OpenKM.

Sample

package com.openkm.extension.frontend.client;

import com.google.gwt.user.client.Window;
import com.openkm.frontend.client.extension.event.HasLanguageEvent.LanguageEventConstant;
import com.openkm.frontend.client.extension.event.handler.LanguageHandlerExtension;

public class HandlerTest implements LanguageHandlerExtension {

    @Override
    public void onChange(LanguageEventConstant event) {
        Window.alert("language event fired");
    }

}

NavigatorHandlerExtension

Tip

Any extension that implements NavigatorHandlerExtension will watch all events fired by the navigator stack panel.

Methods

method	Description
onChange(NavigatorEventConstant event)	Each time there is a new stack panel event, the onChange method will be fired by OpenKM.

Sample

package com.openkm.extension.frontend.client;

import com.google.gwt.user.client.Window;
import com.openkm.frontend.client.extension.event.HasNavigatorEvent.NavigatorEventConstant;
import com.openkm.frontend.client.extension.event.handler.NavigatorHandlerExtension;

public class HandlerTest implements NavigatorHandlerExtension {

    @Override
    public void onChange(NavigatorEventConstant event) {
        Window.alert("navigator event fired");
    }

}

PropertyGroupHandlerExtension 

Tip

Any extension implementing PropertyGroupHandlerExtension will watch all events fired by the metadata group tab.

Methods

method	Description
onChange(PropertyGroupEventConstant event)	Each time there is a new property group (metadata) event, the onChange method will be fired by OpenKM.

Sample

package com.openkm.extension.frontend.client;

import com.google.gwt.user.client.Window;
import com.openkm.frontend.client.extension.event.HasPropertyGroupEvent;
import com.openkm.frontend.client.extension.event.HasPropertyGroupEvent.PropertyGroupEventConstant;
import com.openkm.frontend.client.extension.event.handler.PropertyGroupHandlerExtension;

public class HandlerTest implements PropertyGroupHandlerExtension {

    @Override
    public void onChange(PropertyGroupEventConstant event) {
        if (event.equals(HasPropertyGroupEvent.PROPERTYGROUP_CHANGED)) {
            Window.alert("propertyGroup changed - " + event.getType());
        } else {
            Window.alert("other property group event - " + event.getType());
        }
    }

}

WidgetHandlerExtension

Tip

Any extension that implements WidgetHandlerExtension will watch all events fired by widgets.

Methods

method	Description
onChange(WidgetEventConstant event)	Each time there is a new widget event, the onChange method will be fired by OpenKM.

Sample

package com.openkm.extension.frontend.client;

import com.google.gwt.user.client.Window;
import com.openkm.frontend.client.extension.event.HasWidgetEvent;
import com.openkm.frontend.client.extension.event.HasWidgetEvent.WidgetEventConstant;
import com.openkm.frontend.client.extension.event.handler.WidgetHandlerExtension;

public class HandlerTest implements WidgetHandlerExtension {

    @Override
    public void onChange(WidgetEventConstant event) {
        if (event.equals(HasWidgetEvent.FINISH_STARTUP)) {
            Window.alert("widget event fired");
        }
    }

}

WorkspaceUserPropertiesHandlerExtension 

Tip

Any extension implementing WorkspaceUserHandlerExtension will watch all events fired by the Workspace user.

Methods

method	Description
workspaceUserLoaded()	It is called the first time the workspace user properties are loaded.

Sample

package com.openkm.extension.frontend.client;

import com.google.gwt.user.client.Window;
import com.openkm.frontend.client.extension.communicator.GeneralCommunicator;
import com.openkm.frontend.client.extension.event.handler.WorkspaceUserPropertiesHandlerExtension;

public class HandlerTest implements WorkspaceUserPropertiesHandlerExtension {

    @Override
    public void workspaceUserLoaded() {
        Window.alert("workspace user properties loaded can call GeneralCommunicator to read it");
        if (GeneralCommunicator.getWorkspace() != null) {
            Window.alert("workspace loaded");
        }
    }

}