org.ka2ddo.yaac.pluginapi

Interface ExtraContentElement

public interface ExtraContentElement

This interface defines the data for one of a sequential list of elements to render in a popup window for an ExtraColumn.

Since:

PROVIDER_API_VERSION == 38

Author:

Andrew Pavlin, KA2DDO

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getNextValue() Returns the next larger value for the element.
java.lang.Object	getPreviousValue() Returns the next smaller value for the element.
ExtraContentType	getType() Gets the type of rendering to be performed for this element.
java.lang.Object	getValue() Returns the value for the element.
java.lang.Class<?>	getValueClass() Returns the most specific superclass for the element value.
boolean	isEditable() Returns true if the element is editable.
void	setValue(java.lang.Object aValue) Sets the value in the element.

Method Detail

getType

ExtraContentType getType()

Gets the type of rendering to be performed for this element.

Returns:

ExtraContentType to explain the interpretation of this element.

getValueClass

java.lang.Class<?> getValueClass()

Returns the most specific superclass for the element value.

Returns:

the common ancestor class of the object value.

getValue

java.lang.Object getValue()

Returns the value for the element.

Returns:

the value Object at the specified element

isEditable

boolean isEditable()

Returns true if the element is editable. Otherwise, setValue on the element will not change the value of that element.

Returns:

true if the element is editable

See Also:

setValue(java.lang.Object)

setValue

void setValue(java.lang.Object aValue)

Sets the value in the element.

Parameters:

aValue - the new value

See Also:

getValue(), isEditable()

getNextValue

java.lang.Object getNextValue()

Returns the next larger value for the element. Used to obtain the changed value for SPINNER type elements.

Returns:

the next larger value Object for the element, or null if already at the maximum value or not of SPINNER type

getPreviousValue

java.lang.Object getPreviousValue()

Returns the next smaller value for the element. Used to obtain the changed value for SPINNER type elements.

Returns:

the next smaller value Object for the element, or null if already at the minimum value or not of SPINNER type