content: /*
   *  Licensed to the Apache Software Foundation (ASF) under one
   *  or more contributor license agreements.  See the NOTICE file
   *  distributed with this work for additional information
   *  regarding copyright ownership.  The ASF licenses this file
   *  to you under the Apache License, Version 2.0 (the
   *  "License"); you may not use this file except in compliance
   *  with the License.  You may obtain a copy of the License at
   *
   *        http://www.apache.org/licenses/LICENSE-2.0
   *
   *  Unless required by applicable law or agreed to in writing,
   *  software distributed under the License is distributed on an
   *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
   *  KIND, either express or implied.  See the License for the
   *  specific language governing permissions and limitations
   *  under the License.
   */
  package org.apache.causeway.applib.events.ui;
  
  import java.util.EventObject;
  
  import org.apache.causeway.applib.annotation.DomainObjectLayout;
  
  import lombok.Getter;
  
  /**
   * Emitted for subscribers to obtain a layout hint (equivalent to the
   * <tt>layout()</tt> supporting method).
   *
   * <p>
   * The class has a number of responsibilities:
   * </p>
   *
   * <ul>
   *     <li>
   *          capture the target object being interacted with
   *     </li>
   *     <li>
   *          capture the layout, if any, as specified to one of the subscribers
   *     </li>
   * </ul>
   *
   * <p>
   *  The class itself is instantiated automatically by the framework.
   * </p>
   *
   * @since 1.x {@index}
   */
  public abstract class LayoutUiEvent<S> extends AbstractUiEvent<S> {
  
      /**
       * This class is the default for the
       * {@link DomainObjectLayout#layoutUiEvent()} annotation element.
       *
       * <p>
       * Whether this raises an event or not depends upon the
       * <tt>causeway.applib.annotation.domain-object-layout.layout-ui-event.post-for-default</tt>
       * configuration property.
       * </p>
       */
      public static class Default extends LayoutUiEvent<Object> { }
  
      /**
       * Convenience class to use indicating that an event should <i>not</i> be
       * posted (irrespective of the configuration property setting for the
       * {@link Default} event.
       */
      public static class Noop extends LayoutUiEvent<Object> { }
  
      /**
       * Convenience class meaning that an event <i>should</i> be posted
       * (irrespective of the configuration property setting for the
       * {@link Default} event..
       */
      public static class Doop extends LayoutUiEvent<Object> { }
  
      /**
       * If used then the framework will set state via (non-API) setters.
       *
       * <p>
       *     Because the {@link EventObject} superclass prohibits a null source, a dummy value is temporarily used.
       * </p>
       */
      public LayoutUiEvent() {
          this(null);
      }
  
      public LayoutUiEvent(final S source) {
          super(source);
      }
  
      /**
       * The name of the alternate layout to use, as provided by a subscriber using {@link #setLayout(String)}.
       */
      @Getter
      private String layout;
  
      /**
       * For subscribers to call to provide a layout for this object.
       */
      public void setLayout(final String layout) {
          this.layout = layout;
      }
  
  }
  