oracle.javatools.history

Class HistoryProperty

java.lang.Object

oracle.javatools.history.HistoryProperty

Direct Known Subclasses:

DefaultHistoryProperty

public class HistoryProperty
extends java.lang.Object

Information about a property that HistoryEntry items in a HistoryModel may have.

Since:

release specific (what release of product did this appear in)

Constructor Summary

Constructors

Constructor and Description
HistoryProperty() Construct a history property with no values.
HistoryProperty(java.lang.String name) Construct a HistoryProperty.
HistoryProperty(java.lang.String name, java.lang.String description) Construct a HistoryProperty.
HistoryProperty(java.lang.String name, java.lang.String description, java.lang.Class type) Construct a HistoryProperty.
HistoryProperty(java.lang.String name, java.lang.String description, java.lang.Class type, java.lang.Object prototype) Construct a HistoryProperty.

Method Summary

Modifier and Type	Method and Description
int	getAutoSizeMaximum() Get the maximum width used by the HistoryComponent when auto-sizing columns based on prototypes and values.
java.util.Comparator	getComparator() Set a comparator to be used for this property.
java.lang.String	getDescription() Get the description.
java.lang.String	getName() Get the name of this property.
int	getPreferredAlignment() Get the preferred alignment of this property.
java.lang.Object	getPrototypeValue() Get a prototype value.
java.lang.Class	getType() Get the type of this property.
float	getWeight() Get the column weight of this HistoryProperty.
boolean	isDefault() Get whether the HistoryProperty is visible by default.
void	setAutoSizeMaximum(int autoSizeMaximum) Set the maximum width used by the HistoryComponent when auto-sizing columns based on prototypes and values.
void	setComparator(java.util.Comparator comparator) Set a comparator to be used for this property.
void	setDefault(boolean isDefault) Set whether the HistoryProperty is visible by default.
void	setDescription(java.lang.String description) Set a description for this property.
void	setName(java.lang.String name) Set the name of this property.
void	setPreferredAlignment(int preferredAlignment) Set the preferred alignment of this property.
void	setPrototypeValue(java.lang.Object prototypeValue) Set a prototype value.
void	setType(java.lang.Class type) Set the type of this property.
void	setWeight(float weight) Set the column weight of this HistoryProperty.
java.lang.String	toString() Gets the name.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

HistoryProperty

public HistoryProperty()

Construct a history property with no values.

HistoryProperty

public HistoryProperty(java.lang.String name)

Construct a HistoryProperty.

Parameters:

name - the name of the property.

HistoryProperty

public HistoryProperty(java.lang.String name,
                       java.lang.String description)

Construct a HistoryProperty.

Parameters:

name - the name of the property.

description - a description of the property.

HistoryProperty

public HistoryProperty(java.lang.String name,
                       java.lang.String description,
                       java.lang.Class type)

Construct a HistoryProperty.

Parameters:

name - the name of the property.

description - a description of the property.

type - the class of the property values.

HistoryProperty

public HistoryProperty(java.lang.String name,
                       java.lang.String description,
                       java.lang.Class type,
                       java.lang.Object prototype)

Construct a HistoryProperty.

Parameters:

name - the name of the property.

description - a description of the property.

type - the class of the property values.

prototype - a prototype value.

Method Detail

setWeight

public void setWeight(float weight)

Set the column weight of this HistoryProperty.

Parameters:

weight - the weight value.

getWeight

public float getWeight()

Get the column weight of this HistoryProperty.

Returns:

the weight value.

setDefault

public void setDefault(boolean isDefault)

Set whether the HistoryProperty is visible by default.

Parameters:

isDefault - true if the HistoryProperty is visible.

setAutoSizeMaximum

public void setAutoSizeMaximum(int autoSizeMaximum)

Set the maximum width used by the HistoryComponent when auto-sizing columns based on prototypes and values.

Parameters:

autoSizeMaximum - the maximum auto-size width

setName

public void setName(java.lang.String name)

Set the name of this property.

Parameters:

name - the name of the property.

getName

public java.lang.String getName()

Get the name of this property.

Returns:

the name of this property.

setDescription

public void setDescription(java.lang.String description)

Set a description for this property.

Parameters:

description - a description.

getDescription

public java.lang.String getDescription()

Get the description.

Returns:

the description.

isDefault

public boolean isDefault()

Get whether the HistoryProperty is visible by default.

Returns:

true if the HistoryProperty is visible.

getAutoSizeMaximum

public int getAutoSizeMaximum()

Get the maximum width used by the HistoryComponent when auto-sizing columns based on prototypes and values.

Returns:

the maximum auto-size width

setType

public void setType(java.lang.Class type)

Set the type of this property. This may be used to determine how the renderer used to display the property in the HistoryComponent.

Parameters:

type - the type of the property.

getType

public java.lang.Class getType()

Get the type of this property. This may be used to determine how the renderer used to display the property in the HistoryComponent.

Returns:

the type of the property.

setComparator

public void setComparator(java.util.Comparator comparator)

Set a comparator to be used for this property. This is used by the HistoryComponent to provide column sorting for this property.

Parameters:

comparator - a comparator.

getComparator

public java.util.Comparator getComparator()

Set a comparator to be used for this property. This is used by the HistoryComponent to provide column sorting for this property.

Returns:

a comparator.

setPreferredAlignment

public void setPreferredAlignment(int preferredAlignment)

Set the preferred alignment of this property. This is used by the HistoryComponent to determine the column alignment.

Parameters:

preferredAlignment - one of SwingConstants.LEFT, SwingConstants.CENTER or SwingConstants.RIGHT

getPreferredAlignment

public int getPreferredAlignment()

Get the preferred alignment of this property. This is used by the HistoryComponent to determine the column alignment.

Returns:

one of SwingConstants.LEFT, SwingConstants.CENTER or SwingConstants.RIGHT

setPrototypeValue

public void setPrototypeValue(java.lang.Object prototypeValue)

Set a prototype value. This is used by the HistoryComponent to determine the column width for a property.

Parameters:

prototypeValue - a prototype value for this property.

getPrototypeValue

public java.lang.Object getPrototypeValue()

Get a prototype value. This is used by the HistoryComponent to determine the column width for a property.

Returns:

a prototype value for this property.

toString

public java.lang.String toString()

Gets the name.

Overrides:

toString in class java.lang.Object

Returns:

the name.