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

Show more of this group Show more artifacts with this name
Show all versions of jfxtras-all Show documentation

Miscellaneous components for JavaFX

The newest version!

package jfxtras.icalendarfx.properties;

import javax.annotation.Resources;

import jfxtras.icalendarfx.parameters.AlternateText;
import jfxtras.icalendarfx.properties.PropBaseAltText;
import jfxtras.icalendarfx.properties.PropLanguage;
import jfxtras.icalendarfx.properties.component.relationship.Contact;

/**
 * Property with language, alternate text display, and a text-based value
 *  
 * @param 
 * 
 * @see PropBaseAltText
 * 
 * concrete subclasses
 * @see Comment
 * @see Contact
 * @see Description
 * @see Location
 * @see Resources
 * @see Summary
 */
public interface PropAltText extends PropLanguage
{
    /**
     * 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
     *       
     *     
     *   
     * 
     */
    AlternateText getAlternateText();
    void setAlternateText(AlternateText alternateText);
}