Package org.opencms.gwt.client.ui

Class CmsToggleEvent

java.lang.Object
com.google.web.bindery.event.shared.Event<I_CmsToggleHandler>
com.google.gwt.event.shared.GwtEvent<I_CmsToggleHandler>
org.opencms.gwt.client.ui.CmsToggleEvent
public class CmsToggleEvent extends com.google.gwt.event.shared.GwtEvent<I_CmsToggleHandler>
Event to be fired by a widget being activated or deactivated.

Since:
8.0.0

  • Nested Class Summary

    Nested classes/interfaces inherited from class com.google.gwt.event.shared.GwtEvent

    com.google.gwt.event.shared.GwtEvent.Type<H>

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    CmsToggleEvent(boolean isActivated)
    Creates a new open event.

  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    dispatch(I_CmsToggleHandler handler)
     
    static void
    fire(I_CmsHasToggleHandlers source, boolean isActivated)
    Fires a toggle event on all registered handlers in the handler manager.If no such handlers exist, this method will do nothing.
    com.google.gwt.event.shared.GwtEvent.Type<I_CmsToggleHandler>
    getAssociatedType()
     
    static com.google.gwt.event.shared.GwtEvent.Type<I_CmsToggleHandler>
    getType()
    Gets the type associated with this event.
    boolean
    isActivated()
    Returns if the source has been activated.

    Methods inherited from class com.google.gwt.event.shared.GwtEvent

    assertLive, getSource, isLive, kill, revive

    Methods inherited from class com.google.web.bindery.event.shared.Event

    setSource, toDebugString, toString

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • CmsToggleEvent

      protected CmsToggleEvent(boolean isActivated)
      Creates a new open event.

      Parameters:
      isActivated - if the source has been activated

  • Method Details

    • fire

      public static void fire(I_CmsHasToggleHandlers source, boolean isActivated)
      Fires a toggle event on all registered handlers in the handler manager.If no such handlers exist, this method will do nothing.

      Parameters:
      source - the event source
      isActivated - if the source has been activated

    • getType

      public static com.google.gwt.event.shared.GwtEvent.Type<I_CmsToggleHandler> getType()
      Gets the type associated with this event.
      Returns:
      returns the handler type

    • getAssociatedType

      public com.google.gwt.event.shared.GwtEvent.Type<I_CmsToggleHandler> getAssociatedType()
      Specified by:
      getAssociatedType in class com.google.gwt.event.shared.GwtEvent<I_CmsToggleHandler>
      See Also:
      • GwtEvent.getAssociatedType()

    • isActivated

      public boolean isActivated()
      Returns if the source has been activated.

      Returns:
      if the source has been activated

    • dispatch

      protected void dispatch(I_CmsToggleHandler handler)
      Specified by:
      dispatch in class com.google.gwt.event.shared.GwtEvent<I_CmsToggleHandler>
      See Also:
      • GwtEvent.dispatch(com.google.gwt.event.shared.EventHandler)