Package com.cosylab.vdct.vdb

Class VDBMacro

java.lang.Object

com.cosylab.vdct.vdb.VDBMacro

All Implemented Interfaces:

Descriptable, LinkSource, ChangableVisibility, InspectableProperty

public class VDBMacro
extends Object
implements InspectableProperty, Descriptable, ChangableVisibility, LinkSource

RO property of macro represented on HL (template instance is parent)

Author:

Matej

Field Summary

Fields

Modifier and Type	Field	Description
protected String	comment
protected static String	defaultDescription
protected String	description
protected String	name
protected int	visibility
protected Macro	visibleObject

Fields inherited from interface com.cosylab.vdct.inspector.InspectableProperty

ALWAYS_VISIBLE, NEVER_VISIBLE, NON_DEFAULT_VISIBLE, UNDEFINED_VISIBILITY

Constructor Summary

Constructors

Constructor	Description
VDBMacro(VDBTemplate template, DBMacro macro)	Insert the method's description here.
VDBMacro(VDBTemplate template, String name, String description)	Insert the method's description here.

Method Summary

Modifier and Type	Method	Description
boolean	allowsOtherValues()	Insert the method's description here.
String	checkValueValidity(String value)	Returns null if this value is valid, else the error message.
String	getComment()	Returns the comment.
String	getDescription()	Sets the target.
Pattern	getEditPattern()	Insert the method's description here.
String	getFullName()	Returns the name.
Integer	getGuiGroup()	Returns the gui group index as an Integer or null if no gui group info available.
String	getHelp()	Insert the method's description here.
String	getInitValue()	Insert the method's description here.
String	getMacroDefinition(String templateInstanceName)	Returns macro name
String	getName()	Returns the name.
String	getRealDescription()	Returns the description.
String[]	getSelectableValues()	Insert the method's description here.
VDBTemplate	getTemplate()	Returns the template.
String	getToolTipText()	Insert the method's description here.
int	getType()	Returns type of the source (INPUT, OUTPUT, FORWARD, PORT or MACRO).
String	getValue()	Insert the method's description here.
int	getVisibility()	Insert the method's description here.
Macro	getVisibleObject()	Returns the visibleObject.
boolean	hasDefaultValue()
boolean	hasValidity()
boolean	isEditable()	Insert the method's description here.
boolean	isSeparator()	Insert the method's description here.
boolean	isValid()	Insert the method's description here.
void	popupEvent(Component component, int x, int y)	Insert the method's description here.
void	setComment(String comment)	Sets the comment.
void	setDescription(String description)	Sets the description.
void	setName(String name)	Sets the name.
void	setTemplate(VDBTemplate template)	Sets the template.
void	setValue(String value)	Insert the method's description here.
void	setValueSilently(String newValue)	Insert the method's description here.
void	setVisibility(int visibility)	Insert the method's description here.
void	setVisibleObject(Macro visibleObject)	Sets the visibleObject.

Methods inherited from class java.lang.Object

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

Field Detail

name

protected String name

description

protected String description

comment

protected String comment

defaultDescription

protected static String defaultDescription

visibility

protected int visibility

visibleObject

protected Macro visibleObject

Constructor Detail

VDBMacro

public VDBMacro(VDBTemplate template,
                DBMacro macro)

Insert the method's description here.

Parameters:

template - template

macro - macro

VDBMacro

public VDBMacro(VDBTemplate template,
                String name,
                String description)

Insert the method's description here.

Parameters:

template - template

name - name

description - description

Method Detail

getName

public String getName()

Returns the name.

Specified by:

getName in interface InspectableProperty

Returns:

String

getFullName

public String getFullName()

Returns the name.

Specified by:

getFullName in interface LinkSource

Returns:

String

setName

public void setName(String name)

Sets the name.

Parameters:

name - The name to set

getDescription

public String getDescription()

Sets the target.

Specified by:

getDescription in interface Descriptable

Returns:

java.lang.String

getRealDescription

public String getRealDescription()

Returns the description.

Returns:

String

setDescription

public void setDescription(String description)

Sets the description.

Specified by:

setDescription in interface Descriptable

Parameters:

description - The description to set

getMacroDefinition

public String getMacroDefinition(String templateInstanceName)

Returns macro name

Parameters:

templateInstanceName - The name of the template instance

Returns:

something

getComment

public String getComment()

Returns the comment.

Returns:

String

setComment

public void setComment(String comment)

Sets the comment.

Parameters:

comment - The comment to set

allowsOtherValues

public boolean allowsOtherValues()

Description copied from interface: InspectableProperty

Insert the method's description here. Creation date: (11.1.2001 21:34:58)

Specified by:

allowsOtherValues in interface InspectableProperty

Returns:

boolean

See Also:

InspectableProperty.allowsOtherValues()

getEditPattern

public Pattern getEditPattern()

Description copied from interface: InspectableProperty

Insert the method's description here. Creation date: (11.1.2001 21:30:04)

Specified by:

getEditPattern in interface InspectableProperty

Returns:

java.lang.String

See Also:

InspectableProperty.getEditPattern()

getHelp

public String getHelp()

Description copied from interface: InspectableProperty

Insert the method's description here. Creation date: (26.1.2001 15:01:28)

Specified by:

getHelp in interface InspectableProperty

Returns:

java.lang.String

See Also:

InspectableProperty.getHelp()

getInitValue

public String getInitValue()

Description copied from interface: InspectableProperty

Insert the method's description here. Creation date: (11.1.2001 21:29:48)

Specified by:

getInitValue in interface InspectableProperty

Returns:

java.lang.String

See Also:

InspectableProperty.getInitValue()

getSelectableValues

public String[] getSelectableValues()

Description copied from interface: InspectableProperty

Insert the method's description here. Creation date: (11.1.2001 21:36:10)

Specified by:

getSelectableValues in interface InspectableProperty

Returns:

java.lang.String[]

See Also:

InspectableProperty.getSelectableValues()

getToolTipText

public String getToolTipText()

Description copied from interface: InspectableProperty

Insert the method's description here. Creation date: (11.1.2001 21:30:04)

Specified by:

getToolTipText in interface InspectableProperty

Returns:

java.lang.String

See Also:

InspectableProperty.getToolTipText()

getValue

public String getValue()

Description copied from interface: InspectableProperty

Insert the method's description here. Creation date: (11.1.2001 21:29:48)

Specified by:

getValue in interface InspectableProperty

Specified by:

getValue in interface LinkSource

Returns:

java.lang.String

See Also:

InspectableProperty.getValue()

getVisibility

public int getVisibility()

Description copied from interface: InspectableProperty

Insert the method's description here. Creation date: (11.1.2001 21:30:04)

Specified by:

getVisibility in interface InspectableProperty

Returns:

int

See Also:

InspectableProperty.getVisibility()

isEditable

public boolean isEditable()

Description copied from interface: InspectableProperty

Insert the method's description here. Creation date: (11.1.2001 21:28:51)

Specified by:

isEditable in interface InspectableProperty

Returns:

boolean

See Also:

InspectableProperty.isEditable()

isSeparator

public boolean isSeparator()

Description copied from interface: InspectableProperty

Insert the method's description here. Creation date: (11.1.2001 21:44:32)

Specified by:

isSeparator in interface InspectableProperty

Returns:

boolean

See Also:

InspectableProperty.isSeparator()

isValid

public boolean isValid()

Description copied from interface: InspectableProperty

Insert the method's description here. Creation date: (11.1.2001 21:28:51)

Specified by:

isValid in interface InspectableProperty

Returns:

boolean

See Also:

InspectableProperty.isValid()

popupEvent

public void popupEvent(Component component,
                       int x,
                       int y)

Description copied from interface: InspectableProperty

Insert the method's description here. Creation date: (11.1.2001 21:30:04)

Specified by:

popupEvent in interface InspectableProperty

Parameters:

component - java.awt.Component

x - x

y - y

See Also:

InspectableProperty.popupEvent(Component, int, int)

setValueSilently

public void setValueSilently(String newValue)

Insert the method's description here. Creation date: (9.12.2000 18:11:46)

Specified by:

setValueSilently in interface LinkSource

Parameters:

newValue - java.lang.String

setValue

public void setValue(String value)

Description copied from interface: InspectableProperty

Insert the method's description here. Creation date: (11.1.2001 21:30:04)

Specified by:

setValue in interface InspectableProperty

Specified by:

setValue in interface LinkSource

Parameters:

value - java.lang.String

See Also:

InspectableProperty.setValue(String)

getTemplate

public VDBTemplate getTemplate()

Returns the template.

Returns:

VDBTemplate

setTemplate

public void setTemplate(VDBTemplate template)

Sets the template.

Parameters:

template - The template to set

setVisibility

public void setVisibility(int visibility)

Description copied from interface: ChangableVisibility

Insert the method's description here.

Specified by:

setVisibility in interface ChangableVisibility

Parameters:

visibility - visibility

See Also:

ChangableVisibility.setVisibility(int)

getType

public int getType()

Description copied from interface: LinkSource

Returns type of the source (INPUT, OUTPUT, FORWARD, PORT or MACRO).

Specified by:

getType in interface LinkSource

Returns:

int

See Also:

LinkSource.getType()

getVisibleObject

public Macro getVisibleObject()

Returns the visibleObject.

Returns:

Macro

setVisibleObject

public void setVisibleObject(Macro visibleObject)

Sets the visibleObject.

Parameters:

visibleObject - The visibleObject to set

hasDefaultValue

public boolean hasDefaultValue()

Specified by:

hasDefaultValue in interface InspectableProperty

Returns:

something

hasValidity

public boolean hasValidity()

Specified by:

hasValidity in interface InspectableProperty

Returns:

something

checkValueValidity

public String checkValueValidity(String value)

Description copied from interface: InspectableProperty

Returns null if this value is valid, else the error message.

Specified by:

checkValueValidity in interface InspectableProperty

Parameters:

value - value

Returns:

something

getGuiGroup

public Integer getGuiGroup()

Description copied from interface: InspectableProperty

Returns the gui group index as an Integer or null if no gui group info available.

Specified by:

getGuiGroup in interface InspectableProperty

Returns:

something