/*
    * #%L
    * wcm.io
    * %%
    * Copyright (C) 2019 wcm.io
    * %%
    * Licensed 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.
   * #L%
   */
  package io.wcm.wcm.ui.granite.components.pathfield;
  
  import java.util.ArrayList;
  import java.util.Collections;
  import java.util.List;
  
  import org.osgi.annotation.versioning.ProviderType;
  
  /**
   * Represents a column in the column view.
   */
  @ProviderType
  public final class Column {
  
    private String columnId;
    private boolean hasMore;
    private boolean lazy;
    private boolean isCurrentResource;
    private String activeId;
    private boolean metaElement;
    private final List<ColumnItem> items = new ArrayList<>();
  
    Column() {
      // non-public constructor
    }
  
    /**
     * Returns the column ID.
     * @return Column ID
     */
    public String getColumnId() {
      return this.columnId;
    }
  
    Column columnId(String value) {
      this.columnId = value;
      return this;
    }
  
    /**
     * Indicates if there are more items in the column.
     * @return true if there are more items, false otherwise
     */
    public boolean isHasMore() {
      return this.hasMore;
    }
  
    Column hasMore(boolean value) {
      this.hasMore = value;
      return this;
    }
  
    /**
     * Indicates if the column is loaded lazily.
     * @return true if lazy loading is enabled, false otherwise
     */
    public boolean isLazy() {
      return this.lazy;
    }
  
    Column lazy(boolean value) {
      this.lazy = value;
      return this;
    }
  
    /**
     * Indicates if this column represents the current resource.
     * @return true if current resource, false otherwise
     */
    public boolean isCurrentResource() {
      return this.isCurrentResource;
    }
  
    Column isCurrentResource(boolean value) {
      this.isCurrentResource = value;
      return this;
    }
  
    /**
     * Returns the active item ID in the column.
    * @return Active item ID
    */
   public String getActiveId() {
     return this.activeId;
   }
 
   Column activeId(String value) {
     this.activeId = value;
     return this;
   }
 
   /**
    * Indicates if this column is a meta element.
    * @return true if meta element, false otherwise
    */
   public boolean isMetaElement() {
     return this.metaElement;
   }
 
   Column metaElement(boolean value) {
     this.metaElement = value;
     return this;
   }
 
   void addItem(ColumnItem item) {
     this.items.add(item);
   }
 
   /**
    * Returns the list of items in the column.
    * @return List of column items
    */
   public List<ColumnItem> getItems() {
     return Collections.unmodifiableList(this.items);
   }
 
 }