org.phenotips.configuration.spi

Class UIXRecordSection

java.lang.Object

org.phenotips.configuration.spi.UIXRecordSection

All Implemented Interfaces:

RecordSection

public class UIXRecordSection
extends Object
implements RecordSection

An implementation for RecordSection which reads the configuration from an UIExtension xobject.

Since:

1.4

Version:

$Id: 941775403dd0abb4a04befb7d37938970369e4a5 $

Field Summary

Fields

Modifier and Type	Field and Description
protected List<RecordElement>	elements
protected boolean	enabled
protected boolean	expanded
protected org.xwiki.uiextension.UIExtension	extension
protected org.xwiki.uiextension.UIExtensionFilter	orderFilter Sorts fields by their declared order.
protected org.xwiki.uiextension.UIExtensionManager	uixManager Lists the contained fields.

Constructor Summary

Constructors

Constructor and Description
UIXRecordSection(org.xwiki.uiextension.UIExtension extension, org.xwiki.uiextension.UIExtensionManager uixManager, org.xwiki.uiextension.UIExtensionFilter orderFilter) Simple constructor, taking the UI extension, the uixManager UI extension manager, and the orderFilter UI extension filter as parameters.

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.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

extension

protected final org.xwiki.uiextension.UIExtension extension

See Also:

getExtension()

uixManager

protected final org.xwiki.uiextension.UIExtensionManager uixManager

Lists the contained fields.

orderFilter

protected final org.xwiki.uiextension.UIExtensionFilter orderFilter

Sorts fields by their declared order.

enabled

protected boolean enabled

expanded

protected boolean expanded

elements

protected List<RecordElement> elements

Constructor Detail

UIXRecordSection

public UIXRecordSection(org.xwiki.uiextension.UIExtension extension,
                        org.xwiki.uiextension.UIExtensionManager uixManager,
                        org.xwiki.uiextension.UIExtensionFilter orderFilter)

Simple constructor, taking the UI extension, the uixManager UI extension manager, and the orderFilter UI extension filter as parameters.

Parameters:

extension - the UIExtension object defining this element

uixManager - the UIExtensionManager object

orderFilter - the UIExtensionFilter object for ordering sections and elements

Throws:

IllegalArgumentException - if extension or uixManager or orderFilter are null

Method Detail

getExtension

public org.xwiki.uiextension.UIExtension getExtension()

Description copied from interface: RecordSection

The extension defining this section.

Specified by:

getExtension in interface RecordSection

Returns:

a valid UIExtension object

getName

public String getName()

Description copied from interface: RecordSection

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

Specified by:

getName in interface RecordSection

Returns:

a user-friendly title for this section

isEnabled

public boolean isEnabled()

Description copied from interface: RecordSection

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

Specified by:

isEnabled in interface RecordSection

Returns:

true if this section must be displayed, false otherwise

setEnabled

public void setEnabled(boolean enabled)

Description copied from interface: RecordSection

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.

Specified by:

setEnabled in interface RecordSection

Parameters:

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

isExpandedByDefault

public boolean isExpandedByDefault()

Description copied from interface: RecordSection

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

Specified by:

isExpandedByDefault in interface RecordSection

Returns:

true if this section must be expanded, false otherwise

setExpandedByDefault

public void setExpandedByDefault(boolean expanded)

Description copied from interface: RecordSection

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.

Specified by:

setExpandedByDefault in interface RecordSection

Parameters:

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

getAllElements

public List<RecordElement> getAllElements()

Description copied from interface: RecordSection

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

Specified by:

getAllElements in interface RecordSection

Returns:

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

getEnabledElements

public List<RecordElement> getEnabledElements()

Description copied from interface: RecordSection

The list of elements displayed in this section.

Specified by:

getEnabledElements in interface RecordSection

Returns:

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

setElements

public void setElements(List<RecordElement> elements)

Description copied from interface: RecordSection

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.

Specified by:

setElements in interface RecordSection

Parameters:

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

toString

public String toString()

Overrides:

toString in class Object