public interface

IPropertyDefinition

com.pnfsoftware.jeb.core.properties.IPropertyDefinition
Known Indirect Subclasses

Class Overview

Definition of a property.

Summary

Constants
int FLAG_INTERNAL The property is internal and should not be displayed by clients.
int FLAG_NOT_SUITABLE_FOR_RUN_TIME_OPTIONS The property value is a setting not applicable for run-time modifications.
int FLAG_SIZE_EXTRA Visual size indicator.
int FLAG_SIZE_LARGE Visual size indicator.
int FLAG_SIZE_MEDIUM Visual size indicator.
int FLAG_SIZE_SMALL Visual size indicator.
int FLAG_SIZE_TINY Visual size indicator.
int FLAG_URLENCODED The property value if URL-encoded (for strings only).
int FLAG_VISUAL_STANDOUT This flag indicates that the description of this property is rather large.
Public Methods
abstract String getDescription()
Get a description string for the property.
abstract int getFlags()
Get the property flags.
abstract IPropertyDefinitionManager getManager()
Retrieve the manager for this definition.
abstract String getName()
Get the property name.
abstract IPropertyType getType()
Get the property type.
abstract boolean isInternal()
Convenience method used to determine whether the property is internal.

Constants

public static final int FLAG_INTERNAL

The property is internal and should not be displayed by clients.

Constant Value: 1 (0x00000001)

public static final int FLAG_NOT_SUITABLE_FOR_RUN_TIME_OPTIONS

The property value is a setting not applicable for run-time modifications.

Constant Value: 2 (0x00000002)

public static final int FLAG_SIZE_EXTRA

Visual size indicator.

Constant Value: 128 (0x00000080)

public static final int FLAG_SIZE_LARGE

Visual size indicator.

Constant Value: 64 (0x00000040)

public static final int FLAG_SIZE_MEDIUM

Visual size indicator. This value is useless.

Constant Value: 0 (0x00000000)

public static final int FLAG_SIZE_SMALL

Visual size indicator.

Constant Value: 32 (0x00000020)

public static final int FLAG_SIZE_TINY

Visual size indicator.

Constant Value: 16 (0x00000010)

public static final int FLAG_URLENCODED

The property value if URL-encoded (for strings only).

Constant Value: 4 (0x00000004)

public static final int FLAG_VISUAL_STANDOUT

This flag indicates that the description of this property is rather large. Clients rendering it may want to enclose it in a separate visual component.

Constant Value: 8 (0x00000008)

Public Methods

public abstract String getDescription ()

Get a description string for the property.

Returns
  • the mandatory property description (empty string if none)

public abstract int getFlags ()

Get the property flags.

Returns
  • the property flags, a combination of FLAG_xxx constants

public abstract IPropertyDefinitionManager getManager ()

Retrieve the manager for this definition.

public abstract String getName ()

Get the property name.

Returns
  • the mandatory property name

public abstract IPropertyType getType ()

Get the property type.

Returns
  • the mandatory property flags

public abstract boolean isInternal ()

Convenience method used to determine whether the property is internal. Internal properties should not displayed by clients.

Returns
  • true if the property is internal