Eclipse RSE Development Guide (Galileo) - IProperty (RSE API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

RSE
Release 3.0

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.rse.core.model
Interface IProperty

All Known Implementing Classes:: Property

public interface IProperty

Properties are contained in property sets ( IPropertySet) and may be associated with objects that implement IPropertySetContainer. These would typically be model objects. Properties also have a type (see IPropertyType).

See Also:: IRSEModelObject

Method Summary

String getKey ()


String getLabel ()


IPropertyType getType ()


String getValue ()


boolean isEnabled ()
          Retrieves the "enabled" presentation attribute of this property.

boolean isReadOnly ()
          Retrieves the "read-only" presentation attribute of this property.

void setEnabled (boolean flag)
          Sets the "enabled" presentation attribute of this property.

void setLabel ( String label)
          Sets the displayable label of the property.

void setReadOnly (boolean flag)
          Sets the "read-only" presentation attribute of this property.

void setType ( IPropertyType type)
          Sets the type of this property.

void setValue ( String value)
          Sets the value of this property.

Method Detail

getKey


String getKey()

Returns:: the name of the property.

setLabel

void setLabel(
String label)

Sets the displayable label of the property.

Parameters:: label - the label for this property.

getLabel


String getLabel()

Returns:: the displayable label of this property

setValue

void setValue(
String value)

Sets the value of this property. May raise a runtime exception if the new value of the property is not compatible with its type.

Parameters:: value - the new value for this property.

getValue


String getValue()

Returns:: the value of this property

setType

void setType(
IPropertyType type)

Sets the type of this property. May raise an runtime exception if the value of the property is not compatible with the new type.

Parameters:: type - the property type

getType


IPropertyType getType()

Returns:: the type of this property

setEnabled

void setEnabled(boolean flag)

Sets the "enabled" presentation attribute of this property. This is an attribute that can be used to drive the presentation of this property and does not otherwise affect how this property can be used. Properties are enabled by default.

Parameters:: flag - true if the property is to be enabled.

isEnabled

boolean isEnabled()

Retrieves the "enabled" presentation attribute of this property. This is an attribute that can be used to drive the presentation of this property and does not otherwise affect how this property can be used.

Returns:: true if the property is enabled.

setReadOnly

void setReadOnly(boolean flag)

Sets the "read-only" presentation attribute of this property. This is an attribute that can be used to drive the presentation of this property and does not otherwise affect how this property can be used. Properties are read-write by default.

Parameters:: flag - true if the property is to be read-only.

isReadOnly

boolean isReadOnly()

Retrieves the "read-only" presentation attribute of this property. This is an attribute that can be used to drive the presentation of this property and does not otherwise affect how this property can be used.

Returns:: true if the property is read-only.