Package org.graffiti.plugin
Interface Displayable
- All Known Subinterfaces:
Attribute,CollectionAttribute,LimitableParameter,Parameter,ParameterList,SingleParameter,SortedCollectionAttribute
- All Known Implementing Classes:
AbstractAttribute,AbstractCollectionAttribute,AbstractLimitableParameter,AbstractSingleParameter,ArrowShapeAttribute,AWTImageAttribute,BooleanAttribute,BooleanParameter,ByteAttribute,ChartAttribute,ChartColorAttribute,ChartsColumnAttribute,ClusterColorAttribute,ClusterColorParameter,ColorAttribute,ColorParameter,CompositeAttribute,CompoundAttribute,CompoundPositionAttribute,CoordinateAttribute,DimensionAttribute,DockingAttribute,DoubleAttribute,DoubleParameter,EdgeGraphicAttribute,EdgeLabelAttribute,EdgeLabelPositionAttribute,EdgeParameter,EdgeShapeAttribute,EnumParameter,FloatAttribute,FloatParameter,FontAttribute,GradientFillAttribute,GraphElementGraphicAttribute,HashMapAttribute,ImageAttribute,IndexAttribute,IntegerAttribute,IntegerParameter,JComponentParameter,KeggGroupPartAttribute,KeggIdAttribute,KeggReactionIdAttribute,KeggReactionTypeAttribute,KeggRelationSrcTgtAttribute,KeggRelationSubTypeAttribute,KeggRelationTypeAttribute,KeggTypeAttribute,LabelAlignmentAttribute,LabelAttribute,LabelColorAttribute,LabelFontAttribute,LabelStyleAttribute,LandmarkParameter,LineModeAttribute,LinkedHashMapAttribute,LongAttribute,MultiFileSelectionParameter,NodeGraphicAttribute,NodeLabelAttribute,NodeLabelPositionAttribute,NodeParameter,NodePathwayLinkVisualizationAttribute,NodeShapeAttribute,ObjectAttribute,ObjectListParameter,ObjectParameter,PortAttribute,PortsAttribute,PositionAttribute,SelectionParameter,ShapeDescriptionAttribute,ShortAttribute,SliderParameter,SourceDockingAttribute,StringAttribute,StringParameter,TargetDockingAttribute,ThicknessAttribute,URLAttribute,XMLAttribute
public interface Displayable
DOCUMENT ME!
- Author:
- ph
-
Method Summary
Modifier and Type Method Description StringgetDescription()Returns the short description of this object.JComponentgetIcon()StringgetName()Returns the name of this object.ObjectgetValue()Returns the encapsulated object.voidsetDescription(String desc)Sets a short description of this object.voidsetValue(Object val)Sets the encapsulated object.StringtoXMLString()Returns a well-formed XML string representing the Displayable.
-
Method Details
-
setDescription
Sets a short description of this object.- Parameters:
desc-
-
getDescription
String getDescription()Returns the short description of this object.- Returns:
- String
-
getName
String getName()Returns the name of this object.- Returns:
- String
-
setValue
Sets the encapsulated object.- Parameters:
val-- Throws:
IllegalArgumentException- thrown if val is not of the appropriate type.
-
getValue
Object 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
-
getIcon
JComponent getIcon()
-