| java.lang.Object
 org.pentaho.designstudio.controls.XMLAwareControl
All known Subclasses: org.pentaho.designstudio.controls.XMLAwareTextField,
| XMLAwareControl | | abstract public class XMLAwareControl implements ModifyListener,IXmlModifier(Code) | | Abstract base class for UI controls that are XML aware. The XML aware control modifies the
specified XML node to stay in sync with the text being displayed in the control.
author:
Doug Moran |
| Method Summary | |
| abstract protected void | addModifyListener()
| | protected void | addTheNode()
| | public void | addXmlModificationListener(IXmlModificationListener listener)
| | abstract protected Control | createControl(Composite parent, int style, String labelStr, Object controlLayoutData, Object labelLayoutData)
| | protected void | createLabel(Composite parent, Object layoutData, String labelStr)
| | protected void | deleteTheNode()
| | public void | fireXmlModificationEvent(XmlModificationEvent event)
| | abstract public Control | getControl()
| | public boolean | getDeleteWhenEmpty()
| | protected String | getLabel()
Returns the label to be displayed with the control. | | protected String | getNodeText()
Returns the value of the DOM node. | | public Node | getTargetNode()
| | abstract protected String | getText()
| | public boolean | getUseCData()
| | protected void | initListeners()
| | public void | modifyText(ModifyEvent e)
| | public void | refresh()
Refreshes the underlying control to be in sync. | | abstract protected void | removeModifyListener()
| | public void | removeXmlModificationListener(IXmlModificationListener listener)
| | public void | setDeleteWhenEmpty(boolean delete)
| | abstract protected void | setEnabled(boolean enabled)
Enables and disables the UI control. | | public void | setTargetAttribute(Attribute attribute)
| | public void | setTargetAttribute(Element element, String attributeName)
| | public void | setTargetAttribute(Element ancestor, String xPathToElement, String attributeName)
| | public void | setTargetElement(Element element)
| | public void | setTargetElement(Element ancestor, String xPathToElement)
| | abstract protected void | setText(String textStr)
| | public void | setUseCData(boolean use)
| | protected void | synchronizeNodeWithControl()
Sets the node value to reflect what's in the value of the UI control. |
| ancestorElement | | protected Element ancestorElement(Code) | | |
| deleteWhenEmpty | | boolean deleteWhenEmpty(Code) | | |
| theTargetNode | | protected Node theTargetNode(Code) | | |
| useCData | | boolean useCData(Code) | | |
| XMLAwareControl | | protected XMLAwareControl()(Code) | | Creates an XML aware control.
Parameters:
labelStr - the name of the node that is being kept in sync with the control. |
| XMLAwareControl | | protected XMLAwareControl(Composite parent, String labelStr, Object controlLayoutData, Object labelLayoutData)(Code) | | Creates an XML aware control.
Parameters:
parent - Composite on which to place this guy
Parameters:
parentNode - The parent of the DOM element
Parameters:
labelStr - The node name for this DOM element
Parameters:
controlLayoutData - the layout data for the control
Parameters:
labelLayoutData - the layout data for the label |
| XMLAwareControl | | protected XMLAwareControl(Composite parent, int style, String labelStr, Object controlLayoutData, Object labelLayoutData)(Code) | | Creates an XML aware control.
Parameters:
parent - Composite on which to place this guy
Parameters:
parentNode - The parent of the DOM element
Parameters:
style - the control style
Parameters:
labelStr - The node name for this DOM element
Parameters:
controlLayoutData - the layout data for the control
Parameters:
labelLayoutData - the layout data for the label |
| addModifyListener | | abstract protected void addModifyListener()(Code) | | |
| addTheNode | | protected void addTheNode()(Code) | | |
| createControl | | abstract protected Control createControl(Composite parent, int style, String labelStr, Object controlLayoutData, Object labelLayoutData)(Code) | | Creates the UI control
Parameters:
parent - the parent of this control
Parameters:
toolkit - the toolkit to use when creating the control
Parameters:
span - the span of this control in a TableWrapLayout the UI control |
| createLabel | | protected void createLabel(Composite parent, Object layoutData, String labelStr)(Code) | | |
| deleteTheNode | | protected void deleteTheNode()(Code) | | |
| getControl | | abstract public Control getControl()(Code) | | Returns the UI control
the UI control |
| getDeleteWhenEmpty | | public boolean getDeleteWhenEmpty()(Code) | | |
| getLabel | | protected String getLabel()(Code) | | Returns the label to be displayed with the control.
the label |
| getNodeText | | protected String getNodeText()(Code) | | Returns the value of the DOM node.
the DOM node value. |
| getTargetNode | | public Node getTargetNode()(Code) | | |
| getText | | abstract protected String getText()(Code) | | Returns the text currently in the UI control
the UI control text |
| getUseCData | | public boolean getUseCData()(Code) | | |
| initListeners | | protected void initListeners()(Code) | | |
| modifyText | | public void modifyText(ModifyEvent e)(Code) | | |
| refresh | | public void refresh()(Code) | | Refreshes the underlying control to be in sync. with the DOM node.
|
| removeModifyListener | | abstract protected void removeModifyListener()(Code) | | |
| setDeleteWhenEmpty | | public void setDeleteWhenEmpty(boolean delete)(Code) | | |
| setEnabled | | abstract protected void setEnabled(boolean enabled)(Code) | | Enables and disables the UI control.
|
| setTargetAttribute | | public void setTargetAttribute(Attribute attribute)(Code) | | |
| setTargetAttribute | | public void setTargetAttribute(Element element, String attributeName)(Code) | | |
| setTargetAttribute | | public void setTargetAttribute(Element ancestor, String xPathToElement, String attributeName)(Code) | | |
| setTargetElement | | public void setTargetElement(Element element)(Code) | | |
| setTargetElement | | public void setTargetElement(Element ancestor, String xPathToElement)(Code) | | |
| setText | | abstract protected void setText(String textStr)(Code) | | Sets the text currently in the UI control
Parameters:
textStr - the text to be displayed in the control. |
| setUseCData | | public void setUseCData(boolean use)(Code) | | |
| synchronizeNodeWithControl | | protected void synchronizeNodeWithControl()(Code) | | Sets the node value to reflect what's in the value of the UI control.
|
|
|