Package ch.systemsx.cisd.openbis.generic.shared.basic.dto

Class ManagedUiDescription

java.lang.Object

ch.systemsx.cisd.openbis.generic.shared.basic.dto.ManagedUiDescription

All Implemented Interfaces:

IManagedUiDescription, java.io.Serializable

public class ManagedUiDescription
extends java.lang.Object
implements IManagedUiDescription, java.io.Serializable

Object that declaratively describes a UI (labels, fields, their ordering, table content).

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
ManagedUiDescription()

Method Summary

Modifier and Type	Method	Description
IManagedUiAction	addAction(java.lang.String id)	Adds an action with given name to actions that can be performed in the user interface for modification of the managed property.
ManagedUiTableActionDescription	addTableAction(java.lang.String id)	Adds a table action with given name to actions that can be performed in the user interface for modification of the managed property.
java.util.List<IManagedUiAction>	getActions()	Get all actions defined for the managed property.
IManagedOutputWidgetDescription	getOutputWidgetDescription()	Returns description of the widget that will be shown in detail view of the entity owning the property.
void	setOutputWidgetDescription(IManagedOutputWidgetDescription outputWidget)
void	useHtmlOutput(java.lang.String htmlText)	Tells the UI to show the property the specified HTML.
void	useTableOutput(ITableModel tableModel)	Sets the given table model to define an output that will be shown in detail view of the entity owning the property.

Methods inherited from class java.lang.Object

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

Constructor Detail

ManagedUiDescription

public ManagedUiDescription()

Method Detail

getOutputWidgetDescription

public IManagedOutputWidgetDescription getOutputWidgetDescription()

Description copied from interface: IManagedUiDescription

Returns description of the widget that will be shown in detail view of the entity owning the property.

Specified by:

getOutputWidgetDescription in interface IManagedUiDescription

setOutputWidgetDescription

public void setOutputWidgetDescription(IManagedOutputWidgetDescription outputWidget)

addAction

public IManagedUiAction addAction(java.lang.String id)

Description copied from interface: IManagedUiDescription

Adds an action with given name to actions that can be performed in the user interface for modification of the managed property.

NOTE: currently there is only support for table actions

Specified by:

addAction in interface IManagedUiDescription

addTableAction

public ManagedUiTableActionDescription addTableAction(java.lang.String id)

Description copied from interface: IManagedUiDescription

Adds a table action with given name to actions that can be performed in the user interface for modification of the managed property.

Specified by:

addTableAction in interface IManagedUiDescription

getActions

public java.util.List<IManagedUiAction> getActions()

Description copied from interface: IManagedUiDescription

Get all actions defined for the managed property.

Specified by:

getActions in interface IManagedUiDescription

useTableOutput

public void useTableOutput(ITableModel tableModel)

Description copied from interface: IManagedUiDescription

Sets the given table model to define an output that will be shown in detail view of the entity owning the property. The table will be shown in an extra tab.

Specified by:

useTableOutput in interface IManagedUiDescription

useHtmlOutput

public void useHtmlOutput(java.lang.String htmlText)

Description copied from interface: IManagedUiDescription

Tells the UI to show the property the specified HTML.

Specified by:

useHtmlOutput in interface IManagedUiDescription