- All Known Subinterfaces:
GraphSelection,KeyDescription,ProjectDescription,Selection
- All Known Implementing Classes:
AdditionalNodeFieldsEditor,And,Application,Argument,Array,Attribute,AttributeItem,AutoCompletorFactory,Block,BooleanAttribute,BooleanConst,BooleanEditor,BooleanTreeAttribute,BooleanValueOption,ButtonEditor,ByteAttribute,ByteTreeAttribute,CharAttribute,CharTreeAttribute,CheckBoxItem,ChoiceGroup,CommandItem,CompositeEditor,ConfigureInstance,ContentDescriptionClass,ContentDescriptionConstructor,ContentDescriptionField,ContentDescriptionMethod,ContentDescriptionType,CoolbarItemAdder,CoolbarMacroAdder,CoolbarPanelAdder,CreateMap,DensityTreeAttribute,DescribedLevel,Directory,DoubleAttribute,DoubleTreeAttribute,DTDSourceFile,Edit,EmbeddedFileObject,EmptyViewAdapterFactory,EnumerationEditor,EnumValueImpl,Exclude,Executable,Exists,ExplorerFactory,Expression,Extension,ExtensionItem,FieldSelection,FileFactory,FileObjectItem,FileTypeItem,FilterItem,FilterSourceFactory,First,FloatAttribute,FloatConst,FloatingWindow,FloatTreeAttribute,ForAll,GlobalTransformation,GlobalTransformation,GraphObjectSelection,GraphSelectionImpl,Group,HeightTreeAttribute,HelpExplorerFactory,Hook,IdTreeAttribute,InitializeClass,Insert,InstanceOf,IntAttribute,IntConst,IntEnumerationAttribute,IntTreeAttribute,Item,ItemData,ItemDescriptor,ItemFactory,KeyDescriptionImpl,LAF,Layout,LayoutNavigationFactory,LazyObjectItem,Library,Link,LocationParameterTreeAttribute,LongAttribute,LongTreeAttribute,MainWindow,MapSource,Matrix3dAttribute,Matrix3fAttribute,Matrix4dAttribute,Matrix4fAttribute,MethodEditor,MimeTypeItem,MTGSourceFile,NavigatorFactory,NodeReference,NodeSelection,Not,NullConst,NumberEditor,NumberTreeAttribute,NumericEditor,ObjectAttribute,ObjectExpr,ObjectItem,ObjectItemFactory,ObjectMethod,ObjectSelection,ObjectTreeAttribute,Option,OptionExplorerFactory,OptionFileBase,OptionGroup,OptionsSelection,OptionsSource,Or,OutlineExplorer,PanelFactory,ParentAttribute,PluginDescriptor,PluginExclude,PluginPrerequisite,Point2dAttribute,Point2fAttribute,Point3dAttribute,Point3fAttribute,PointConst,PolyEditor,Prerequisite,ProjectDirectory,ProjectExplorerFactory,ProjectFileObjectItem,ProjectSelection,PropertyEditor,ReferenceData,RegistryViewEventFactory,Resource,ResourceDirectory,ResourceLibrary,Root,SearchExplorerFactory,SelectableItem,SelectionBase,Separator,SetVar,SharedValue,ShortAttribute,ShortCut,ShortTreeAttribute,SONodeReference,SourceDirectory,SourceFile,SourceMTG,SpecialEdgeDescriptor,Split,StringAttribute,StringConst,StringEditor,Tab,TextTransferHandlerFactory,ToolBarFactory,ToolFactory,TreeValuesTreeAttribute,Tuple2dAttribute,Tuple2fAttribute,Tuple3dAttribute,Tuple3fAttribute,Tuple4dAttribute,Tuple4fAttribute,TurtleStateAttribute,TypedVar,TypeItem,UIDataHandler,UIPropertyDependency,UITransferHandlerFactory,UserFieldsEditor,Value,Var,VariableDescriptionContent,Vars,Vector2dAttribute,Vector2fAttribute,Vector3dAttribute,Vector3fAttribute,ViewComponentFactory,Void,VoidAttribute,VolumeAttribute,XLMacro,XSLTFilterItem
public interface Described
An instance of
Described provides descriptions
for an object. The descriptions are obtained by the method
getDescription(String). Which particular description is
returned depends on the argument type: It
is one of the string constants defined in this interface.- Author:
- Ole Kniemeyer
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringConstant forgetDescription(String)specifying an accelerator key to be used as the accelerator for the object.static final StringConstant forgetDescription(String)specifying an icon.static final StringConstant forgetDescription(String)specifying a key code to be used as the mnemonic for the object.static final StringConstant forgetDescription(String)specifying the name.static final StringConstant forgetDescription(String)specifying a short description.static final StringConstant forgetDescription(String)specifying a title. -
Method Summary
Modifier and TypeMethodDescriptiongetDescription(String type) Returns the description associated with the giventype.
-
Field Details
-
NAME
Constant forgetDescription(String)specifying the name. The returned value has to be aString, it is used, among others, for menus and buttons.- See Also:
-
SHORT_DESCRIPTION
Constant forgetDescription(String)specifying a short description. The returned value has to be aString, it is used, among others, for tooltip text.- See Also:
-
TITLE
Constant forgetDescription(String)specifying a title. The returned value has to be aString, it is used for titles.- See Also:
-
ICON
Constant forgetDescription(String)specifying an icon. The returned value has to be an instance ofIconSource.- See Also:
-
MNEMONIC_KEY
Constant forgetDescription(String)specifying a key code to be used as the mnemonic for the object. The returned value has to be an instance ofNumberorCharacter.- See Also:
-
ACCELERATOR_KEY
Constant forgetDescription(String)specifying an accelerator key to be used as the accelerator for the object. The returned value has to be an instance ofKeyStrokeor aStringwhich can be converted to aKeyStrokebyKeyStroke.getKeyStroke(String).- See Also:
-
-
Method Details
-
getDescription
Returns the description associated with the giventype.typehas to be one of the predefined constants of this interface, the returned value has to conform to the specification of the used constant.- Parameters:
type- the type of description- Returns:
- the description, or
nullif no description is available
-