ComputedFieldMetaClass.java

/*
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package com.xpn.xwiki.objects.meta;

import javax.inject.Named;
import javax.inject.Singleton;

import org.xwiki.component.annotation.Component;

import com.xpn.xwiki.objects.classes.ComputedFieldClass;
import com.xpn.xwiki.objects.classes.PropertyClassInterface;
import com.xpn.xwiki.objects.classes.TextAreaClass;

/**
 * Computed Field Class allows to create a field without storage that will display computed values based on other data
 * in the object or wiki.
 *
 * @version $Id: 919be400ec7fae315c04b309f81ab0b3ad833723 $
 * @since 4.2M2
 */
@Component
@Named("ComputedField")
@Singleton
public class ComputedFieldMetaClass extends PropertyMetaClass
{
    /**
     * Constructor for ComputerFieldMetaClass.
     */
    public ComputedFieldMetaClass()
    {
        setPrettyName("Computed Field");
        setName(getClass().getAnnotation(Named.class).value());

        TextAreaClass scriptClass = new TextAreaClass(this);
        scriptClass.setName("script");
        scriptClass.setPrettyName("Script");
        scriptClass.setEditor("Text");
        scriptClass.setSize(80);
        scriptClass.setRows(5);
        safeput(scriptClass.getName(), scriptClass);
    }

    @Override
    public PropertyClassInterface getInstance()
    {
        return new ComputedFieldClass();
    }
}