org.wicketstuff.animator.MarkupIdModel.java Source code

Introduction

Here is the source code for org.wicketstuff.animator.MarkupIdModel.java

Source

/*
 * 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.wicketstuff.animator;

import java.util.Collection;
import java.util.HashSet;
import java.util.Set;

import org.apache.wicket.Component;
import org.apache.wicket.model.LoadableDetachableModel;

/**
 * This is a convenience class for extracting the markupIds of the provided
 * components. Use this class to create models for the target parameter of any
 * StyleSubject.
 * 
 * @author Gerolf Seitz
 * 
 */
public class MarkupIdModel extends LoadableDetachableModel {

    private static final long serialVersionUID = 1L;
    private Set<Component> components;

    /**
     * Constructs the model and adds the specified component.
     * 
     * @param component
     *            the component to be added.
     */
    public MarkupIdModel(Component component) {
        add(component);
    }

    /**
     * Constructs the model and adds the specified components.
     * 
     * @param components
     *            the components to be added.
     */
    public MarkupIdModel(Collection<? extends Component> components) {
        add(components);
    }

    /**
     * Use this method to add another component to the model.
     * 
     * @param component
     *            the component to be added.
     * @return this {@link MarkupIdModel} for fluent method calls.
     */
    public MarkupIdModel add(Component component) {
        if (components == null) {
            components = new HashSet<Component>();
        }
        component.setOutputMarkupId(true);
        components.add(component);
        return this;
    }

    /**
     * Use this method to add more components to the model.
     * 
     * @param components
     *            the components to be added.
     * @return this {@link MarkupIdModel} for fluent method calls.
     */
    public MarkupIdModel add(Collection<? extends Component> components) {
        if (components == null) {
            components = new HashSet<Component>();
        }
        for (Component component : components) {
            component.setOutputMarkupId(true);
            add(component);
        }
        return this;
    }

    /*
     * (non-Javadoc)
     * 
     * @see org.apache.wicket.model.LoadableDetachableModel#load()
     */
    @Override
    protected Object load() {
        Set<String> ids = new HashSet<String>();
        for (Component component : components) {
            ids.add(component.getMarkupId());
        }
        return ids;
    }
}