com.bowstreet.generation
Interface DynamicBuilderInputDefinition

All Superinterfaces:

BuilderInputDefinition, com.bowstreet.generation.ProfileableEntity, com.bowstreet.generation.ProfiledElement, com.bowstreet.generation.ProfiledStringElement

public interface DynamicBuilderInputDefinition
extends BuilderInputDefinition, com.bowstreet.generation.ProfiledStringElement, com.bowstreet.generation.ProfileableEntity

Field Summary

static int	PT_ELEMENTS
static int	PT_NONE
static int	PT_VALUE

Fields inherited from interface com.bowstreet.generation.BuilderInputDefinition

TY_BOOLEAN, TY_OBJECT, TY_STRING, TY_XML

Method Summary

java.util.Map	getArguments() Get all the arguments
java.lang.String	getBaseBuilderCall() Get the base builder call to use to initialize this input, or null if none.
java.lang.String	getBaseInputID() Gets this input's base input definition
boolean	getBoolean() Gets the data as a boolean.
java.lang.String	getCoordinatorNamespace() Get the name of the space to use when running a shared coordinator - inputs with matching values will be visible to each other and will use the same coordinator instance.
java.lang.String	getEditorClassName() Gets the widget class name
java.lang.String	getGroupID() Get the group ID this input is associated with (null if not in a group)
java.lang.Object	getInitialValue() Gets the initial (default) value of this builder input
com.bowstreet.editor.uitools.widgets.Widget	getInputEditor() Gets current editor widget.
java.lang.Object	getObject() Gets the named data as a Object.
java.lang.String	getPageID() Get the page ID this input is associated with (null if not on a specified page)
java.lang.String	getPathFinder() This will return null or the name of a class that implements com.bowstreet.designer.eclipse.util.FileOpenerListener$PathFinder If it is non-null, the Label will instead be a link to open the element named by the getString method.
java.lang.String	getProfileEntry()
java.lang.String	getString() Gets the named data as a String.
boolean	getUseAssociatedCoordinator() Get the flag controlling whether any coordinator associated with this input will be run when this input is used.
IXml	getXml() Gets the named data as a IXml.
boolean	hasValue() See if this builder input has a value.
void	removeValue() Removes input value from BuilderInputs
void	setArgument(java.lang.String argumentName, java.lang.Object value) This is used to set properties for editor widgets.
void	setBaseBuilderCall(java.lang.String modelAndCallID) Set the page ID this input is associated with.
void	setBoolean(boolean value) Sets the named data with the specified boolean value.
void	setCoordinatorNamespace(java.lang.String namespace) Set the name of the space to use when running a shared coordinator.
void	setEditorClassName(java.lang.String javaClassName, boolean clearArguments) Change which widget is used to edit this element Example widget classes: com.bowstreet.editor.uitools.widgets.BComboBox com.bowstreet.editor.uitools.widgets.BButton com.bowstreet.editor.uitools.widgets.BCheckBox com.bowstreet.editor.uitools.widgets.BIndirectValue com.bowstreet.editor.uitools.widgets.BTextArea com.bowstreet.editor.uitools.widgets.FileChooser com.bowstreet.editor.uitools.widgets.BTextField com.bowstreet.editor.uitools.widgets.BRadioBox
void	setGroupID(java.lang.String id) Set the group ID this input is associated with.
void	setHelpText(java.lang.String text) Set help text
void	setInputEditor(com.bowstreet.editor.uitools.widgets.Widget editor) Use a specific editor widget (internal use).
void	setObject(java.lang.Object value) Sets the named data with the specified Object value.
void	setPageID(java.lang.String id) Set the page ID this input is associated with.
void	setPathFinder(java.lang.String pathFinder) Set the name of a class that implements com.bowstreet.designer.eclipse.util.FileOpenerListener$PathFinder to make the Label be, instead, a link which opens the element named by the getString method.
void	setPrompt(java.lang.String prompt) Sets prompt
void	setRequired(boolean isRequired) Sets required property of the builder input.
void	setString(java.lang.String value) Sets the named data with the specified String value.
void	setUseAssociatedCoordinator(boolean useCoordinator) Set the flag controlling whether any coordinator associated with this input will be run when this input is used.
void	setVisible(boolean isVisible) Shows or hides the input.
void	setXml(IXml value) Sets the named data with the specified IXml value.

Methods inherited from interface com.bowstreet.generation.BuilderInputDefinition

getEmptyValueReplacement, getHelpText, getName, getProfileType, getPrompt, getType, isAvailableInPropertyPanel, isCallable, isDeprecated, isRequired, isVisible, makeDynamicCopy

Methods inherited from interface com.bowstreet.generation.ProfiledElement

getFixedWidth, getHelpText, getName, getProfileType, getPrompt, isRequired, setProfileEntry

Methods inherited from interface com.bowstreet.generation.ProfileableEntity

getHelpText, getName, getProfileType, getPrompt, isProfiled, isRequired, setProfileEntry

Field Detail

PT_ELEMENTS

static final int PT_ELEMENTS

See Also:

Constant Field Values

PT_NONE

static final int PT_NONE

See Also:

Constant Field Values

PT_VALUE

static final int PT_VALUE

See Also:

Constant Field Values

Method Detail

getArguments

java.util.Map getArguments()

Get all the arguments

Specified by:

getArguments in interface BuilderInputDefinition

Returns:

Map of all the arguments to the widget.

getBaseBuilderCall

java.lang.String getBaseBuilderCall()

Get the base builder call to use to initialize this input, or null if none.

Returns:

String the model ID and builder call ID, separated by a colon.

getBaseInputID

java.lang.String getBaseInputID()

Gets this input's base input definition

Returns:

The ID of the base input, or null if there is no base

getBoolean

boolean getBoolean()

Gets the data as a boolean.

Returns:

the boolean value of the named data.

getCoordinatorNamespace

java.lang.String getCoordinatorNamespace()

Get the name of the space to use when running a shared coordinator - inputs with matching values will be visible to each other and will use the same coordinator instance.

Returns:

String namespace ID

getEditorClassName

java.lang.String getEditorClassName()

Gets the widget class name

Specified by:

getEditorClassName in interface com.bowstreet.generation.ProfileableEntity

Returns:

The editor class name

getGroupID

java.lang.String getGroupID()

Get the group ID this input is associated with (null if not in a group)

Returns:

String ID of group name

getInitialValue

java.lang.Object getInitialValue()

Gets the initial (default) value of this builder input

Returns:

The initial value of this builder input

getInputEditor

com.bowstreet.editor.uitools.widgets.Widget getInputEditor()

Gets current editor widget.

Returns:

The Widget object, null if createInputEditor has never been called.

getObject

java.lang.Object getObject()

Gets the named data as a Object.

Specified by:

getObject in interface com.bowstreet.generation.ProfileableEntity

Returns:

the Object value of the named data.

getPageID

java.lang.String getPageID()

Get the page ID this input is associated with (null if not on a specified page)

Returns:

String ID of page name

getPathFinder

java.lang.String getPathFinder()

This will return null or the name of a class that implements com.bowstreet.designer.eclipse.util.FileOpenerListener$PathFinder If it is non-null, the Label will instead be a link to open the element named by the getString method.

getProfileEntry

java.lang.String getProfileEntry()

Specified by:

getProfileEntry in interface com.bowstreet.generation.ProfileableEntity

Specified by:

getProfileEntry in interface com.bowstreet.generation.ProfiledElement

Returns:

the profile entry string if this BuilderInput is profile-enabled at the top level.

getString

java.lang.String getString()

Gets the named data as a String.

Specified by:

getString in interface com.bowstreet.generation.ProfiledStringElement

Returns:

the String value of the named data.

getUseAssociatedCoordinator

boolean getUseAssociatedCoordinator()

Get the flag controlling whether any coordinator associated with this input will be run when this input is used.

Returns:

true if the associated coordinator should be used.

getXml

IXml getXml()

Gets the named data as a IXml.

Returns:

the IXml value of the named data.

hasValue

boolean hasValue()

See if this builder input has a value.

Returns:

true if there is a value for this BuilderInput

removeValue

void removeValue()

Removes input value from BuilderInputs

setArgument

void setArgument(java.lang.String argumentName,
                 java.lang.Object value)

This is used to set properties for editor widgets. Properties available for all widgets: "width", "height", "background", "foreground", "ToolTipText" (tool tip for hover). For BComboBox and BRadioBox: "listDataObject" (List object for pick list) or "listData" (String for pick list), "listLabelsObject" (List object labels for pick list) or "listLabels" (String labels for pick list), "isEditable" ("true" if can type in), "selectItem" (selected item). BButton: "label" (button label). BTextArea: "rows" (visible rows).

Parameters:

argumentName - The name of the property to set

value - The property value

setBaseBuilderCall

void setBaseBuilderCall(java.lang.String modelAndCallID)

Set the page ID this input is associated with.

Parameters:

modelAndCallID - the model ID and builder call ID, separated by a colon.

setBoolean

void setBoolean(boolean value)

Sets the named data with the specified boolean value.

Parameters:

value - The value to set on the specified name.

setCoordinatorNamespace

void setCoordinatorNamespace(java.lang.String namespace)

Set the name of the space to use when running a shared coordinator.

Parameters:

namespace - name.

setEditorClassName

void setEditorClassName(java.lang.String javaClassName,
                        boolean clearArguments)

Change which widget is used to edit this element Example widget classes: com.bowstreet.editor.uitools.widgets.BComboBox com.bowstreet.editor.uitools.widgets.BButton com.bowstreet.editor.uitools.widgets.BCheckBox com.bowstreet.editor.uitools.widgets.BIndirectValue com.bowstreet.editor.uitools.widgets.BTextArea com.bowstreet.editor.uitools.widgets.FileChooser com.bowstreet.editor.uitools.widgets.BTextField com.bowstreet.editor.uitools.widgets.BRadioBox

Parameters:

javaClassName - The editor widget class name to use from now on

clearArguments - true if the Arguments should be cleared

setGroupID

void setGroupID(java.lang.String id)

Set the group ID this input is associated with.

Parameters:

id - Group name.

setHelpText

void setHelpText(java.lang.String text)

Set help text

Parameters:

text - The new help text

setInputEditor

void setInputEditor(com.bowstreet.editor.uitools.widgets.Widget editor)

Use a specific editor widget (internal use).

Parameters:

editor - the Widget instance to use as an editor

setObject

void setObject(java.lang.Object value)

Sets the named data with the specified Object value.

Specified by:

setObject in interface com.bowstreet.generation.ProfileableEntity

Parameters:

value - The value to set on the specified name.

setPageID

void setPageID(java.lang.String id)

Set the page ID this input is associated with.

Parameters:

id - Page name.

setPathFinder

void setPathFinder(java.lang.String pathFinder)

Set the name of a class that implements com.bowstreet.designer.eclipse.util.FileOpenerListener$PathFinder to make the Label be, instead, a link which opens the element named by the getString method.

Parameters:

pathFinder -

setPrompt

void setPrompt(java.lang.String prompt)

Sets prompt

Parameters:

prompt - The new prompt

setRequired

void setRequired(boolean isRequired)

Sets required property of the builder input. CAVEAT: This is for UI display purposes only. The generation engine will not know if you set this on a dynamic builder input definition. Your builder's generation code (doBuilderCall()) still needs to check for existence of this input, if you require it.

Parameters:

isRequired - - whether or not this builder input is required

setString

void setString(java.lang.String value)

Sets the named data with the specified String value.

Specified by:

setString in interface com.bowstreet.generation.ProfiledStringElement

Parameters:

value - The value to set on the specified name.

setUseAssociatedCoordinator

void setUseAssociatedCoordinator(boolean useCoordinator)

Set the flag controlling whether any coordinator associated with this input will be run when this input is used.

Parameters:

useCoordinator - the model ID and builder call ID, separated by a colon.

setVisible

void setVisible(boolean isVisible)

Shows or hides the input.

Parameters:

isVisible - Set true to make visible

setXml

void setXml(IXml value)

Sets the named data with the specified IXml value.

Parameters:

value - The value to set on the specified name.