org.phenotips.configuration

Interface RecordSection

All Known Implementing Classes:

UIXRecordSection

@Unstable
public interface RecordSection

Represents a section that can be displayed in a record.

Since:

1.0M9

Version:

$Id: a94f62d01f0e4f4337605bd5280d6f253a8384fa $

Method Summary

Modifier and Type	Method and Description
List<RecordElement>	getAllElements() The list of elements configured in this section, whether they are enabled or not.
List<RecordElement>	getEnabledElements() The list of elements displayed in this section.
org.xwiki.uiextension.UIExtension	getExtension() The extension defining this section.
String	getName() The name of this section, displayed in the record and in the form designer.
boolean	isEnabled() Whether this section and its elements are going to be displayed in the record or not.
boolean	isExpandedByDefault() Whether this section should be expanded and fully visible in edit mode by default.
void	setElements(List<RecordElement> elements) Set the list of elements configured in this section.
void	setEnabled(boolean enabled) Set whether this section and its elements are going to be displayed in the record or not.
void	setExpandedByDefault(boolean expanded) Set whether this section should be expanded and fully visible in edit mode by default.

Method Detail

getExtension

org.xwiki.uiextension.UIExtension getExtension()

The extension defining this section.

Returns:

a valid UIExtension object

getName

String getName()

The name of this section, displayed in the record and in the form designer.

Returns:

a user-friendly title for this section

isEnabled

boolean isEnabled()

Whether this section and its elements are going to be displayed in the record or not.

Returns:

true if this section must be displayed, false otherwise

setEnabled

void setEnabled(boolean enabled)

Set whether this section and its elements are going to be displayed in the record or not. All changes are done in-memory for this object only, the configuration will remain unchanged.

Parameters:

enabled - true if this section must be displayed, false otherwise

Since:

1.4

isExpandedByDefault

boolean isExpandedByDefault()

Whether this section should be expanded and fully visible in edit mode by default.

Returns:

true if this section must be expanded, false otherwise

setExpandedByDefault

void setExpandedByDefault(boolean expanded)

Set whether this section should be expanded and fully visible in edit mode by default. All changes are done in-memory for this object only, the configuration will remain unchanged.

Parameters:

expanded - true if this section must be expanded, false otherwise

Since:

1.4

getAllElements

List<RecordElement> getAllElements()

The list of elements configured in this section, whether they are enabled or not.

Returns:

an unmodifiable ordered list of elements, empty if this section doesn't have any elements

getEnabledElements

List<RecordElement> getEnabledElements()

The list of elements displayed in this section.

Returns:

an unmodifiable ordered list of enabled elements, empty if none are configured or enabled

setElements

void setElements(List<RecordElement> elements)

Set the list of elements configured in this section. Each element still decides whether it is enabled or not. All changes are done in-memory for this object only, the configuration will remain unchanged.

Parameters:

elements - the new list of elements to be included in this section, may be empty

Since:

1.4