com.contentful.java.cma.model

Class CMAEditorInterface.Control

java.lang.Object

com.contentful.java.cma.model.CMAEditorInterface.Control

Enclosing class:

CMAEditorInterface

public static class CMAEditorInterface.Control
extends Object

This class represents one control of the editor interface.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CMAEditorInterface.Control.BuildInWidgetId Enum holding the build in values of a widget id.

Constructor Summary

Constructors

Constructor and Description
Control()

Method Summary

Modifier and Type	Method and Description
CMAEditorInterface.Control	addHelpText(String helpText) Adds a new custom help text to the settings.
CMAEditorInterface.Control	addSetting(String key, String value) Adds a new custom setting to the settings.
CMAEditorInterface.Control.BuildInWidgetId	getBuildInWidgetId()
String	getFieldId()
String	getHelpText()
Map<String,String>	getSettings()
String	getWidgetId()
CMAEditorInterface.Control	setBuildInWidgetId(CMAEditorInterface.Control.BuildInWidgetId buildInWidgetId) Use a build in widget.
CMAEditorInterface.Control	setFieldId(String fieldId) Change the id of the field for this control.
CMAEditorInterface.Control	setWidgetId(String widgetId) Set the id of the widget.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Control

public Control()

Method Detail

getFieldId

public String getFieldId()

Returns:

the field id this control applies to.

setFieldId

public CMAEditorInterface.Control setFieldId(String fieldId)

Change the id of the field for this control.

Parameters:

fieldId - new id to be set.

Returns:

this instance for chaining.

getBuildInWidgetId

public CMAEditorInterface.Control.BuildInWidgetId getBuildInWidgetId()

Returns:

the current set build in widget or null if a custom ui extension is used.

setBuildInWidgetId

public CMAEditorInterface.Control setBuildInWidgetId(CMAEditorInterface.Control.BuildInWidgetId buildInWidgetId)

Use a build in widget.

For custom ids, as in for using a custom ui extension widgets, please take a look at setWidgetId(String).

Parameters:

buildInWidgetId - an id pointing to a build in widget.

Returns:

this instance for chaining.

getWidgetId

public String getWidgetId()

Returns:

the current widget id as a string.

See Also:

CMAEditorInterface.Control.BuildInWidgetId, setBuildInWidgetId(BuildInWidgetId)

setWidgetId

public CMAEditorInterface.Control setWidgetId(String widgetId)

Set the id of the widget.

Use this setter if you want to use a custom ui extension widget, and take a look at setBuildInWidgetId(BuildInWidgetId) if you want to select a build in editor widget.

Parameters:

widgetId - the new widget id

Returns:

this instance for chaining.

See Also:

CMAEditorInterface.Control.BuildInWidgetId, setBuildInWidgetId(BuildInWidgetId)

addSetting

public CMAEditorInterface.Control addSetting(String key,
                                             String value)

Adds a new custom setting to the settings.

Side effect: might create a new map, if no map was created before.

Parameters:

key - the settings key to be added.

value - the value of the key to be added.

Returns:

this instance for chaining.

addHelpText

public CMAEditorInterface.Control addHelpText(String helpText)

Adds a new custom help text to the settings.

Side effect: might create a new map, if no map was created before.

Parameters:

helpText - display this text to the user.

Returns:

this instance for chaining.

getHelpText

public String getHelpText()

Returns:

the set help text or null if none is set.

getSettings

public Map<String,String> getSettings()

Returns:

a list of currently set settings, or null if none is set.

toString

public String toString()

Overrides:

toString in class Object

Returns:

a human readable string, representing the object.