com.cosylab.vdct.vdb
Class VDBMacro

java.lang.Object
  extended by com.cosylab.vdct.vdb.VDBMacro
All Implemented Interfaces:
Descriptable, LinkSource, ChangableVisibility, InspectableProperty

public class VDBMacro
extends java.lang.Object
implements InspectableProperty, Descriptable, ChangableVisibility, LinkSource

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

Author:
Matej

Field Summary
protected  java.lang.String comment
           
protected static java.lang.String defaultDescription
           
protected  java.lang.String description
           
protected  java.lang.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
VDBMacro(VDBTemplate template, DBMacro macro)
          Insert the method's description here.
VDBMacro(VDBTemplate template, java.lang.String name, java.lang.String description)
          Insert the method's description here.
 
Method Summary
 boolean allowsOtherValues()
          Insert the method's description here.
 java.lang.String checkValueValidity(java.lang.String value)
          Returns null if this value is valid, else the error message.
 java.lang.String getComment()
          Returns the comment.
 java.lang.String getDescription()
          Sets the target.
 java.util.regex.Pattern getEditPattern()
          Insert the method's description here.
 java.lang.String getFullName()
          Returns the name.
 java.lang.Integer getGuiGroup()
          Returns the gui group index as an Integer or null if no gui group info available.
 java.lang.String getHelp()
          Insert the method's description here.
 java.lang.String getInitValue()
          Insert the method's description here.
 java.lang.String getMacroDefinition(java.lang.String templateInstanceName)
          Returns macro name
 java.lang.String getName()
          Returns the name.
 java.lang.String getRealDescription()
          Returns the description.
 java.lang.String[] getSelectableValues()
          Insert the method's description here.
 VDBTemplate getTemplate()
          Returns the template.
 java.lang.String getToolTipText()
          Insert the method's description here.
 int getType()
          Returns type of the source (INPUT, OUTPUT, FORWARD, PORT or MACRO).
 java.lang.String getValue()
          Returns link target.
 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(java.awt.Component component, int x, int y)
          Insert the method's description here.
 void setComment(java.lang.String comment)
          Sets the comment.
 void setDescription(java.lang.String description)
          Sets the description.
 void setName(java.lang.String name)
          Sets the name.
 void setTemplate(VDBTemplate template)
          Sets the template.
 void setValue(java.lang.String value)
          Sets (value of )the link target.
 void setValueSilently(java.lang.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 java.lang.String name

description

protected java.lang.String description

comment

protected java.lang.String comment

defaultDescription

protected static java.lang.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.


VDBMacro

public VDBMacro(VDBTemplate template,
                java.lang.String name,
                java.lang.String description)
Insert the method's description here.

Method Detail

getName

public java.lang.String getName()
Returns the name.

Specified by:
getName in interface InspectableProperty
Returns:
String

getFullName

public java.lang.String getFullName()
Returns the name.

Specified by:
getFullName in interface LinkSource
Returns:
String

setName

public void setName(java.lang.String name)
Sets the name.

Parameters:
name - The name to set

getDescription

public java.lang.String getDescription()
Sets the target.

Specified by:
getDescription in interface Descriptable
Parameters:
target - The target to set
Returns:
java.lang.String

getRealDescription

public java.lang.String getRealDescription()
Returns the description.

Returns:
String

setDescription

public void setDescription(java.lang.String description)
Sets the description.

Specified by:
setDescription in interface Descriptable
Parameters:
description - The description to set

getMacroDefinition

public java.lang.String getMacroDefinition(java.lang.String templateInstanceName)
Returns macro name

Parameters:
templateInstanceName - The name of the template instance

getComment

public java.lang.String getComment()
Returns the comment.

Returns:
String

setComment

public void setComment(java.lang.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 java.util.regex.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.String getValue()
Description copied from interface: LinkSource
Returns link target.

Specified by:
getValue in interface LinkSource
Specified by:
getValue in interface InspectableProperty
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(java.awt.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
See Also:
InspectableProperty.popupEvent(Component, int, int)

setValueSilently

public void setValueSilently(java.lang.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(java.lang.String value)
Description copied from interface: LinkSource
Sets (value of )the link target.

Specified by:
setValue in interface LinkSource
Specified by:
setValue in interface InspectableProperty
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
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

hasValidity

public boolean hasValidity()
Specified by:
hasValidity in interface InspectableProperty

checkValueValidity

public java.lang.String checkValueValidity(java.lang.String value)
Description copied from interface: InspectableProperty
Returns null if this value is valid, else the error message.

Specified by:
checkValueValidity in interface InspectableProperty
Returns:

getGuiGroup

public java.lang.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: