com.logabit.xlayout

Class XLayout

java.lang.Object

com.logabit.xlayout.XLayout

public class XLayout
extends Object

This is the layout representation of an XLayout definition.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTR_AUTO_COMPLETION
static String	ATTR_CATEGORY
static String	ATTR_ELEMENT_NAME
static String	ATTR_INPUT_TYPE
static String	ATTR_ITEMS
static String	ATTR_MULTI_LINES
static String	ATTR_OPTIONAL
static String	ATTR_RELATED_ATTRIBUTE_NAME
static String	ATTR_REQUIRED
static String	ATTR_TEXT

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	XLayout(Map<String,ControlHandlerConfig> handlerConfigs, ClassLoader resourceClassLoader)

Method Summary

Modifier and Type	Method and Description
boolean	controlExists(String id) Returns true if a control with the given name exists.
void	dispose() Disposes all registered controls to release their resources and removes them from the layout.
void	draw(Composite parent, com.logabit.xlayout.source.XLayoutSource source, String type, boolean showButtons) Renders the editor.
void	fireFocusEvent() To be called When the controls lost the focus.
List<info.textgrid.lab.core.metadataeditor.elements.IControl>	getAllControlElements()
List<Control>	getAllControls() Returns a list of all used controls in the Metadata editor.
info.textgrid.lab.core.metadataeditor.elements.SourceControlElement	getCollectingSourceElement()
Control	getControl(String id) Return the control instance as given by id in the xLayout file.
info.textgrid.lab.core.metadataeditor.elements.IControl	getControlElementById(String id)
info.textgrid.lab.core.metadataeditor.elements.CustomControlElement	getCustomElement()
ScrolledForm	getForm()
Label	getInfoLabel()
org.apache.axiom.om.OMElement	getOMElement() Returns an OMElement which represents the meta data in the meta data editor.
Map<String,info.textgrid.lab.core.metadataeditor.elements.ICheckableElement>	getPathControlsMap()
info.textgrid.lab.core.metadataeditor.elements.SpecificControlElement	getSpecificElement()
boolean	isDisposed()
boolean	isDoCollectSourceElements()
boolean	isEditable() is used metadata part editable?
boolean	isModified() Determines whether the content of the editor was modified or not.
boolean	isThrowExceptionIfControlNotFound() Returns whether an
boolean	isVisible() Determines whether the Metadata editor is visible or hidden
Composite	parseTable(org.dom4j.Element tableElement, Composite parent) Parses the given table element.
void	registerMetadataPart(IMetadataPart part) Registers the meta data's view
void	setCollectingSourceElement(info.textgrid.lab.core.metadataeditor.elements.SourceControlElement collectingSourceElement)
void	setDoCollectSourceElements(boolean doCollectSourceElements)
void	setModified(boolean modified) Sets the editor as modified or not-modified.
void	setOMElement(org.apache.axiom.om.OMElement root, String specificElementName, String textGridUri) Sets the meta data in the Metadata editor.
void	setThrowExceptionIfControlNotFound(boolean throwException) Sets whether an
void	setVisible(boolean visible) Controls the visibility of the Metadata editor.
void	updateDecorationForAgents()

Methods inherited from class java.lang.Object

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

Field Detail

ATTR_ELEMENT_NAME

public static final String ATTR_ELEMENT_NAME

See Also:

Constant Field Values

ATTR_RELATED_ATTRIBUTE_NAME

public static final String ATTR_RELATED_ATTRIBUTE_NAME

See Also:

Constant Field Values

ATTR_INPUT_TYPE

public static final String ATTR_INPUT_TYPE

See Also:

Constant Field Values

ATTR_REQUIRED

public static final String ATTR_REQUIRED

See Also:

Constant Field Values

ATTR_MULTI_LINES

public static final String ATTR_MULTI_LINES

See Also:

Constant Field Values

ATTR_CATEGORY

public static final String ATTR_CATEGORY

See Also:

Constant Field Values

ATTR_OPTIONAL

public static final String ATTR_OPTIONAL

See Also:

Constant Field Values

ATTR_ITEMS

public static final String ATTR_ITEMS

See Also:

Constant Field Values

ATTR_TEXT

public static final String ATTR_TEXT

See Also:

Constant Field Values

ATTR_AUTO_COMPLETION

public static final String ATTR_AUTO_COMPLETION

See Also:

Constant Field Values

Constructor Detail

XLayout

protected XLayout(Map<String,ControlHandlerConfig> handlerConfigs,
                  ClassLoader resourceClassLoader)

Method Detail

getCollectingSourceElement

public info.textgrid.lab.core.metadataeditor.elements.SourceControlElement getCollectingSourceElement()

setCollectingSourceElement

public void setCollectingSourceElement(info.textgrid.lab.core.metadataeditor.elements.SourceControlElement collectingSourceElement)

isDoCollectSourceElements

public boolean isDoCollectSourceElements()

setDoCollectSourceElements

public void setDoCollectSourceElements(boolean doCollectSourceElements)

getControl

public Control getControl(String id)

Return the control instance as given by id in the xLayout file.

Parameters:

id - The id of the control within the xLayout file.

Returns:

The control instance with given id or null if no such control with the given id was found.

setThrowExceptionIfControlNotFound

public void setThrowExceptionIfControlNotFound(boolean throwException)

Sets whether an

Parameters:

throwException - True if an exception must be thrown.

See Also:

must be thrown if a control with given id was requested but was not found.

isThrowExceptionIfControlNotFound

public boolean isThrowExceptionIfControlNotFound()

Returns whether an

Returns:

True if a exception must be thrown

See Also:

must be thrown if a control with given id was requested but was not found.

draw

public void draw(Composite parent,
                 com.logabit.xlayout.source.XLayoutSource source,
                 String type,
                 boolean showButtons)

Renders the editor.

Parameters:

parent -

source -

showButtons -

getForm

public ScrolledForm getForm()

parseTable

public Composite parseTable(org.dom4j.Element tableElement,
                            Composite parent)
                     throws ParseException

Parses the given table element. If the argument parent is null, a new composite will be created. Otherwise the existing parent will be used.

Parameters:

tableElement - The table element which contains the layout information.

parent - The parent composite to use or null if a new one should be created.

Returns:

Throws:

ParseException

setOMElement

public void setOMElement(org.apache.axiom.om.OMElement root,
                         String specificElementName,
                         String textGridUri)

Sets the meta data in the Metadata editor.

Parameters:

root - the meta data OM-Element

getOMElement

public org.apache.axiom.om.OMElement getOMElement()

Returns an OMElement which represents the meta data in the meta data editor.

Returns:

the OMElement which represents the content in the meta editor

getCustomElement

public info.textgrid.lab.core.metadataeditor.elements.CustomControlElement getCustomElement()

getSpecificElement

public info.textgrid.lab.core.metadataeditor.elements.SpecificControlElement getSpecificElement()

getAllControlElements

public List<info.textgrid.lab.core.metadataeditor.elements.IControl> getAllControlElements()

getControlElementById

public info.textgrid.lab.core.metadataeditor.elements.IControl getControlElementById(String id)

isModified

public boolean isModified()

Determines whether the content of the editor was modified or not.

Returns:

boolean

setModified

public void setModified(boolean modified)

Sets the editor as modified or not-modified.

Parameters:

modified -

setVisible

public void setVisible(boolean visible)

Controls the visibility of the Metadata editor.

Parameters:

visible - true or false

isVisible

public boolean isVisible()

Determines whether the Metadata editor is visible or hidden

Returns:

boolean

isEditable

public boolean isEditable()

is used metadata part editable?

Returns:

getAllControls

public List<Control> getAllControls()

Returns a list of all used controls in the Metadata editor.

Returns:

list of Controls

controlExists

public boolean controlExists(String id)

Returns true if a control with the given name exists.

Parameters:

id -

Returns:

boolean

registerMetadataPart

public void registerMetadataPart(IMetadataPart part)

Registers the meta data's view

Parameters:

view -

fireFocusEvent

public void fireFocusEvent()

To be called When the controls lost the focus.

updateDecorationForAgents

public void updateDecorationForAgents()

See Also:

#setDecorationForControls()}

getPathControlsMap

public Map<String,info.textgrid.lab.core.metadataeditor.elements.ICheckableElement> getPathControlsMap()

getInfoLabel

public Label getInfoLabel()

isDisposed

public boolean isDisposed()

dispose

public void dispose()

Disposes all registered controls to release their resources and removes them from the layout.