org.wings.template.PropertyManager Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of wings Show documentation
The newest version!
/*
 * Copyright 2000,2005 wingS development team.
 *
 * This file is part of wingS (http://wingsframework.org).
 *
 * wingS 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.
 *
 * Please see COPYING for the complete licence.
 */
package org.wings.template;

import org.wings.SComponent;

/**
 * Property Manager responsible to handle inline attributes in template layouts for specific component classes.
 * 
 * Besides the dyanmic layout managers components can also be layouted inside the {@link org.wings.STemplateLayout}s.
 * In your template files you can use the 
<object name="aConstraintName"></object>

 * to place specific components inside this template i.e. like panel.add(new SLabel("a label"), "aConstraintName"));.
 * 

 * The template layout mechanism is able to inline set properties of the arranged component inside the template.
 * This feature can be very useful if i.e. a web developer is soley responsible for the whole application Look & Feel.
 * Depending on the type of the arranged component he can modify different visual properties (i.e. background color,
 * display text, etc.) just by modifying the template file.
 * I.e. let's assume you are placing the mentioned label oject in you template file. The the web designer can
 * overwrite the components background, display text, etc. by modifying his object inclusion tag to
 * 
<object name="aConstraintName" background="#ff0000" text="new text"></object>
 *
 * @author Armin Haaf
 */
public interface PropertyManager {

    /**
     * Describe setProperty method here.
     *
     * @param comp  a SComponent value
     * @param name  a String value
     * @param value a String value
     */
    public void setProperty(SComponent comp, String name, String value);

    /**
     * Describe getSupportedClasses method here.
     *
     * @return a Class[] value
     */
    public Class[] getSupportedClasses();
}