jfxtras.icalendarfx.properties.PropBaseAltText Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jfxtras-icalendarfx Show documentation
There is a newer version: 17-r1
package jfxtras.icalendarfx.properties;

import java.net.URI;

import javax.annotation.Resources;

import jfxtras.icalendarfx.parameters.AlternateText;
import jfxtras.icalendarfx.properties.PropAltText;
import jfxtras.icalendarfx.properties.PropBaseAltText;
import jfxtras.icalendarfx.properties.PropBaseLanguage;
import jfxtras.icalendarfx.properties.component.descriptive.Comment;
import jfxtras.icalendarfx.properties.component.descriptive.Description;
import jfxtras.icalendarfx.properties.component.descriptive.Location;
import jfxtras.icalendarfx.properties.component.descriptive.Summary;
import jfxtras.icalendarfx.properties.component.relationship.Contact;
import jfxtras.icalendarfx.utilities.StringConverter;

/**
 * Property with language, alternate text display, and a text-based value
 *  
 * @param 
 * 
 * concrete subclasses
 * @see Comment
 * @see Contact
 * @see Description
 * @see Location
 * @see Resources
 * @see Summary
 */
public abstract class PropBaseAltText extends PropBaseLanguage implements PropAltText
{
    /**
     * ALTREP : Alternate Text Representation
     * To specify an alternate text representation for the property value.
     * 
     * Example:
     * DESCRIPTION;ALTREP="CID:[email protected]":
     *  Project XYZ Review Meeting will include the following agenda
     *   items: (a) Market Overview\, (b) Finances\, (c) Project Man
     *  agement
     *
     *The "ALTREP" property parameter value might point to a "text/html"
     *content portion.
     *
     * Content-Type:text/html
     * Content-Id:
     *
     * 
     *   
     *    
     *   
     *   
     *     
     *       Project XYZ Review Meeting will include
     *       the following agenda items:
     *       

     *         Market Overview
     *         Finances
     *         Project Management
     *       
     *     
     *   
     * 
     */
    @Override
    public AlternateText getAlternateText() { return alternateText; }
    private AlternateText alternateText;
    @Override
    public void setAlternateText(AlternateText alternateText)
    {
    	orderChild(this.alternateText, alternateText);
    	this.alternateText = alternateText;
	}
    public void setAlternateText(String value)
    {
    	setAlternateText(AlternateText.parse(new AlternateText(), value));
	}
    public U withAlternateText(AlternateText altrep)
    {
    	setAlternateText(altrep);
    	return (U) this;
	}
    public U withAlternateText(URI value)
    {
    	setAlternateText(new AlternateText(value));
    	return (U) this;
	}
    public U withAlternateText(String content)
    {
    	setAlternateText(content);
    	return (U) this;
	}
    
    /*
     * CONSTRUCTORS
     */    
    // copy constructor
    public PropBaseAltText(PropBaseAltText property)
    {
        super(property);
    }

    public PropBaseAltText(T value, StringConverter converter)
    {
        super(value);
    }
    
    protected PropBaseAltText()
    {
        super();
    }
}