org.graffiti.plugin
Interface Displayable<T>

All Known Subinterfaces:
Attribute, CollectionAttribute, LimitableParameter<T>, Parameter<T>, ParameterList<T>, SingleParameter<T>, SortedCollectionAttribute
All Known Implementing Classes:
AbstractAttribute, AbstractCollectionAttribute, AbstractLimitableParameter, AbstractSingleParameter, AttributeParameter, BooleanAttribute, BooleanParameter, ByteAttribute, ColorAttribute, CompositeAttribute, CoordinateAttribute, DimensionAttribute, DockingAttribute, DoubleAttribute, DoubleParameter, EdgeGraphicAttribute, EdgeLabelAttribute, EdgeLabelPositionAttribute, EdgeParameter, EdgeShapeAttribute, FloatAttribute, FloatParameter, GraphElementGraphicAttribute, GraphGraphicAttribute, GridAttribute, GridClassAttribute, GridOriginAttribute, GridParametersAttribute, HashMapAttribute, ImageAttribute, IntegerAttribute, IntegerParameter, LabelAttribute, LineModeAttribute, LinkedHashMapAttribute, LongAttribute, NodeGraphicAttribute, NodeLabelAttribute, NodeLabelPositionAttribute, NodeParameter, NodeShapeAttribute, ObjectAttribute, ObjectParameter, PortAttribute, PortsAttribute, PositionAttribute, ProbabilityParameter, RenderedImageAttribute, SelectionParameter, ShapeDescriptionAttribute, ShortAttribute, SnapOnGridAttribute, SnapOnGridAttribute.SnapEnabledAttribute, SnapOnGridAttribute.ToleranceAttribute, StringAttribute, StringParameter, StringSelectionParameter

public interface Displayable<T>

DOCUMENT ME!

Author:
ph

Method Summary
 String getDescription()
          Returns a short description of this object.
 String getName()
          Returns the name of this object.
 T getValue()
          Returns the encapsulated object.
 void setDescription(String desc)
          Sets a short description of this object.
 void setValue(T val)
          Sets the encapsulated object.
 String toXMLString()
          Returns a well-formed XML string representing the Displayable.
 

Method Detail

setDescription

void setDescription(String desc)
Sets a short description of this object.

Parameters:
desc -

getDescription

String getDescription()
Returns a short description of this object.

Returns:
String

getName

String getName()
Returns the name of this object.

Returns:
String

setValue

void setValue(T val)
              throws IllegalArgumentException
Sets the encapsulated object.

Parameters:
val -
Throws:
IllegalArgumentException - thrown if val is not of the apropriate type.

getValue

T getValue()
Returns the encapsulated object.

Returns:
Object

toXMLString

String toXMLString()
Returns a well-formed XML string representing the Displayable. The Displayable should be reconstructable via this representation. Therefore it must at least include the type of Displayable (classname) and a representation of its value. PROBABLE FUTURE DESIGN: The Displayables themselves will provide a method to reconstruct their value from the XML representation they provided.

Returns:
string holding an XML representation of this Displayable


Generated at 2012-05-30 11:00:36 PM CEST