UnComponentProxy

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

de.ug2t.unifiedGui
Class UnComponentProxy

java.lang.Object
  de.ug2t.unifiedGui.UnComponentProxy

All Implemented Interfaces:: IKeRegisteredObject, IKeTreeElement, IKeTreeNode, IUnComponent

public class UnComponentProxy
extends java.lang.Object
implements IUnComponent
extends java.lang.Object
implements IUnComponent

Field Summary

Fields inherited from interface de.ug2t.unifiedGui.interfaces.IUnComponent
`CURSOR_CROSSHAIR, CURSOR_HAND, CURSOR_MOVE, CURSOR_POINTER, CURSOR_WAIT, EVENT_LATENCY_MOVE, EVENT_LATENCY_RESIZE, EVENT_LATENCY_SCROLL, IMG_ALIGN_CENTER, IMG_ALIGN_NORTH, IMG_ALIGN_SOUTH, INSETS_BORDER, LINE_BORDER, NO_BORDER, OUTSETS_BORDER, TEXT_ALIGN_CENTER, TEXT_ALIGN_EAST, TEXT_ALIGN_WEST`

Constructor Summary
`UnComponentProxy(java.lang.String xRefName)`

Method Summary
`KeTreeElement`	`addElement(java.lang.String xName, KeTreeElement xNode)` Adds a child-elelemt into this node.
`KeTreeElement`	`addElement(java.lang.String xName, KeTreeElement xNode, int xIdx)` Adds a child-element into this node at a given index.
`KeTreeElement`	`addElement(java.lang.String xName, KeTreeElement xNode, KeTreeElement xBehind)` Adds a child-element into this node behind a given child-node or child-element.
`KeTreeElement`	`addElementLocal(java.lang.String xName, KeTreeElement xNode)` Adds a child-elelemt into this node.
`void`	`addEventChannel(IUnEventChannel xEvC)` Adds an event channel to the widget.
`void`	`addIndirectListener(IUnGuiEventListener xListener)` Adds an indirect listener to the widget.
`void`	`addListener(IUnGuiEventListener xListener)` Adds a listener to the widget.
`KeTreeNode`	`addNode(java.lang.String xName, KeTreeNode xNode)` Adds a child-node into this node.
`KeTreeNode`	`addNode(java.lang.String xName, KeTreeNode xNode, int xIdx)` Adds a child-node into this node at a given index.
`KeTreeNode`	`addNode(java.lang.String xName, KeTreeNode xNode, KeTreeElement xBehind)` Adds a child-node into this node behind a given child-node or child-element.
`KeTreeNode`	`addNodeLocal(java.lang.String xName, KeTreeNode xNode)` Adds a child-node into this node.
`void`	`addPostFct(IUnPostDisplayFunction xXpostFct)` Adds a post-display function to the widget.
`void`	`addPreFct(IUnPreDisplayFunction xXpreFct)` Adds a pre-display function to the widget.
`void`	`addPropertyChangedListener(IKePropertyChangeListener xListen)` Adds a property changed listener.
`void`	`clear()` Deletes the (sub)tree which is represented by this node, but excludes this node and all subtrees of this node are kept alive
`void`	`clearAndRelease()` Deletes the (sub)tree which is represented by this node, but excludes this node
`void`	`clearIndirectListeners()` Removes all indirect listeners
`void`	`clearListeners()` Removes all listeners
`void`	`consumeEvent()` Consumes the event for this widget.
`boolean`	`contains(KeTreeElement xObj)` Tests if a node/element is inserted in the tree.
`void`	`deepSubNodeVector(java.util.ArrayList xL_vect)` Inserts all nodes of the (sub)tree which is represented by this node into an array
`void`	`delete()` Deletes an object from the registry
`void`	`deleteFixedSize()` Deletes a fixed size setting from a widget
`void`	`disable()` Disables the element
`void`	`disableSubmit()` Disables the submit Flag of a component
`void`	`disableThis()` Disables the element
`void`	`draw()` Initiates a repaint of the widget.
`void`	`enable()` Enables the element
`void`	`enableSubmit()` Enables the submit flag of a widget.
`void`	`enableThis()` Enables the element
`void`	`ensureUnhide()` Unhides all parents of this element
`java.lang.Object`	`execView()` Produces a view from this node.
`void`	`getAllDisabled(java.util.ArrayList xRes)` Gets all disabled nodes/elements and includes ths node/element
`void`	`getAllEnabled(java.util.ArrayList xRes)` Gets all enabled nodes/elements and includes ths node/element
`void`	`getAllParentGenerations(java.util.ArrayList xToAdd)` Gets all (parent)node above this node
`int`	`getAllSubCount(boolean xCountHide)` Returns 0 because tree_elements can not hold any children
`java.util.ArrayList`	`getAllSubNames()` Gets all child-node and child element names
`java.util.ArrayList`	`getAllSubs()` Gets all child-nodes and child elements
`IUnApplication`	`getAppl()` Gets the application which is the owner of this widget
`java.lang.String`	`getBgColor()` Gets the background-color of a widget.
`int`	`getBorder()` Gets the the border-style [NO_BORDER \|\| INSETS_BORDER \|\| OTSETS_BORDER \|\| LINE_BORDER]
`java.lang.String`	`getBorderColor()` Gets the the border color
`int`	`getBorderWidth()` Gets the border width in pixel
`KeTreeElement`	`getByPath(java.lang.String xPath)` Gets a sub-node or sub-element by its path.
`int`	`getChildCount()` Returns 0 because tree_elements can not hold any children
`java.lang.String`	`getCssClass()` Gets the style-sheet class (MARKUP only)
`java.lang.String`	`getCurser()` Gets the cursor of the component
`ACoDataGetter`	`getDataGetter()` Returns the current data getter.
`java.util.Iterator`	`getDeepSubNodeIt()` Creates an iterator over all nodes of the (sub)tree which is represented by this node
`java.lang.Object`	`getDefaultValue()` Returns the default value
`KeTreeElement`	`getElementAt(int xIdx)` Gets a child-node or chld-element at a given index.
`boolean`	`getEventOnChange()` Returns whether only value-change leads to an event or not
`java.lang.String`	`getFgColor()` Gets the foreground-color of a widget.
`UnFixedSize`	`getFixedSize()` Gets the fixed size of a widget
`UnFontDescriptor`	`getFont()` Gets the font which is used to display text within the widget.
`boolean`	`getGlobal()` Gets the information whether the page is global accessible from client-side or not
`java.util.ArrayList`	`getIndirectListeners()` Gets an ArraList with all indirect listeners
`int`	`getIterativeEventLatency()` Gets the latency time
`KeTreeNode`	`getLastParentNode()` Gets the last parent node of this element.
`java.util.ArrayList`	`getListeners()` Gets an ArraList with all listeners
`IMoValue`	`getModel()` Gets the model value which belongs to the widget.
`IMoValue`	`getModelTpl()` Gets the template of the model-value which belongs to the widget.
`IMoValue`	`getModelTpl(java.lang.String xTpl)` Gets the special template of the model-value which belongs to the widget.
`boolean`	`getMultipleParents()` For internal use only
`boolean`	`getMyPropChanged()` Gets the myProperty flag of an element.
`java.lang.String`	`getName()` Gets the name of this element
`KeTreeNode`	`getNodeAt(int xIdx)` Gets a child-node or chld-element at a given index.
`KeTreeElement`	`getParentGeneration(int xGeneration)` Gets a (parent)node above this node
`KeTreeNode`	`getParentNode()` Gets the parent node of this element.
`int`	`getParentNodeCount()` Gets the depth of the tree from the root node to this element
`PlBasicComponentAggregat`	`getParentPlugin()` Returns a related plugin parent object if available
`java.util.Iterator`	`getParents()` Returns an iterator over all parent nodes of this element
`java.util.ArrayList`	`getParentsList()` Returns a list with all parent nodes of this element
`java.lang.String`	`getPath()` Returns the absolute path of this node
`PlBasicComponentAggregat`	`getPluginPeer()` Returns a related plugin object if available
`boolean`	`getPropChanged()` Gets the property flag of an element.This flag is true if a property is changed directly or the property of any child had changed
`java.util.ArrayList`	`getPropertyChangedListeners()` Returns the list with all property changed listeners
`boolean`	`getRenderIfHidden()` The renderIfHidden flag indicates that a widget is rendered always
`KeTreeElement`	`getRootNode()` Gets the root node of a tree
`KeTreeElement`	`getSub(java.lang.String xName)` Gets a sub-node or sub-element by its name.
`int`	`getSubCount()` Similar to getChildCount
`KeTreeElement`	`getSubElement(java.lang.String xName)` Gets a sub-element by its name.
`java.util.Iterator`	`getSubIterator()` Creates an iterator over all child-nodes and child-elements
`java.util.Iterator`	`getSubNameIterator()` Creates an iterator over all child-node and child-element names
`KeTreeNode`	`getSubNode(java.lang.String xName)` Gets a sub-node by its name.
`boolean`	`getTakeMaxSpace()` Gets the maxSpace property (MARKUP only)
`java.lang.String`	`getToolTip()` Gets the tooltip which has been set to this widget.
`UnComponent`	`getUnComponent()` Gets the associated gui-object which implements all common methods
`java.lang.Object`	`getValue()` Gets the value of the element
`IKeView`	`getView()` Gets the view of this node
`boolean`	`hasCtxMenu()` Returns wheter the component has a context menu or not, this flag is set once the context menu is added.
`void`	`hide()` Hide this node
`void`	`hideAll()` Hides all children (in deep search manner) and the node itself
`void`	`hideAllChildren()` Hides all children (in deep search manner)
`void`	`hideLevel(int xLevel)` Hides all children (in deep search manner) starting by the specified depth
`int`	`indexOf(KeTreeElement xEl)` Gets the index of a child-node or child-element with the list of child-nodes.
`boolean`	`isChildOf(KeTreeNode xNode)` Returns whether this node is part of the subtree of xNode or not
`boolean`	`isDefSet()` Returns whether a default is set or not
`boolean`	`isDeleted()` For internal use only
`boolean`	`isDisabled()` Returns the disabled flag of this element
`boolean`	`isGlobal()` Returns whether this object is registered globally or not
`boolean`	`isHidden()` Returns the hidden-flag of this node
`boolean`	`isIndirectRefreshed()` Gets the status of the widgets indirect refresh flag
`boolean`	`isLocal()` Returns whether this object is registered localy or not
`boolean`	`isOwner()` Returns the ownership flag
`boolean`	`isParentDisabled()` Returns whether a parent is disabled or not
`boolean`	`isParentHidden()` Returns whether a parent is hidden or not
`boolean`	`isRefreshed()` Gets the status of the widgets refresh flag
`boolean`	`isRegistered()` Returns whether this object is registered or not
`boolean`	`isSubmit()` Disables the submit flag of a widget.
`IMoValue`	`newModelValue(java.lang.String xName, boolean xChilds)` Creates a new model-value from the template.
`IMoValue`	`newModelValue(java.lang.String xName, boolean xChilds, boolean xFull)` Creates a new model-value from the template.
`IMoValue`	`newModelValue(java.lang.String xName, boolean xChilds, boolean xFull, java.lang.String xExclude)` Creates a new model-value from the template.
`IMoValue`	`newModelValue(java.lang.String xName, boolean xChilds, boolean xFull, java.lang.String xExclude, boolean xDisableRegister)` Creates a new model-value from the template.
`void`	`pushValues()` pushes the values back to the source of the data-getter
`void`	`pushValuesRecursive()` pushes the values back to the source of the data-getter recursively
`void`	`receiveValues()` A call to this function make the widget load a new value from an associated data-getter sets only the value of the component
`void`	`receiveValuesRecursive()` Calls the receiveValue for the complete subtree
`int`	`register(java.lang.String xName)` Registers an object in the currently running threads namespace which is derived from KeRegisteredObject
`int`	`registerGlobal(java.lang.String xName)` Registers an object in the global namespace which is derived from KeRegisteredObject
`void`	`releaseSubs()` For internal use only
`void`	`reload()` Reloads the data getter
`void`	`reloadRecursive()` Reloads the data getter recursive
`void`	`remEventChannel(IUnEventChannel xEvC)` Removes an event channle from a widget.
`void`	`remIndirectListener(IUnGuiEventListener xListener)` Removes an indirect listener from a widget.
`void`	`remListener(IUnGuiEventListener xListener)` Removes a listener from a widget.
`KeTreeElement`	`removeElement(KeTreeElement xNode)` Removes a given element
`KeTreeElement`	`removeElement(java.lang.String xName)` Removes a element with a given name
`KeTreeNode`	`removeNode(KeTreeNode xNode)` Removes a given node
`KeTreeNode`	`removeNode(java.lang.String xName)` Removes a node with a given name
`KeTreeNode`	`removeNodeLocal(KeTreeNode xNode)` Removes a given node
`KeTreeNode`	`removeNodeLocal(java.lang.String xName)` Removes a node with a given name
`void`	`removePropertyChangedListener(IKePropertyChangeListener xListen)` Removes a property changed listener.
`void`	`remPostFct(IUnPostDisplayFunction xXpostFct)` Removes a post-display function from a widget
`void`	`remPreFct(IUnPreDisplayFunction xXpreFct)` Removes a pre-display function from a widget
`void`	`repaint()` Initiates a complete repaint and reinitialise of the widget.
`void`	`requestFocus()` Requests the input-focus for the widget.
`java.lang.Object`	`reset()` Resets the elements value to the default value
`void`	`resetColorSettings()` Deletes all (foreground/background) color settings of a widget
`void`	`resetPropertyChangeFlag()` This method resets the property change flag recursively.
`java.lang.Object`	`resetRecursive()` For internal use only
`void`	`selfRefresh()` A call to this function make the widget load a new value from an associated data-getter
`void`	`selfRefreshRecursive()` Calls the self-refresh for the complete subtree
`void`	`setAppl(IUnApplication xAppl)` Sets the application which owns this widget.
`void`	`setBgColor(java.lang.String xCol)` Sets the background-color of the widget.
`void`	`setBorder(int xBorder, java.lang.String xColor, int xWidth)` Sets a border line.
`void`	`setCssClass(java.lang.String xClass)` Sets the style-sheet class of the widget (MARKUP only)
`void`	`setCursor(java.lang.String xCursor)` Sets the cursor of the component
`void`	`setDataGetter(ACoDataGetter xDg, java.lang.String xId, boolean xRefresh)` Associates a data-getter object with this widget.
`void`	`setDefaultValue(java.lang.Object xObj)` Sets a default value for this element
`void`	`setEarlyAutoDelete(boolean xWR)` Sets this object to early auto delete.
`void`	`setEventOnChange(boolean xEvC)` Sets whether only value-change leads to an event or not
`void`	`setFgColor(java.lang.String xCol)` Sets the foreground-color of the widget.
`void`	`setFixedSize(int xW, int xH, int xType)` Applies a fixed size to a widget
`void`	`setFont(UnFontDescriptor xFont)` Sets the font which is used to display text within the widget.
`void`	`setGlobal(boolean xGlobal)` Sets a widget as global.
`void`	`setIndirectRefresh()` Sets a indirect refresh flag of the widget.
`void`	`setIterativeEventLatency(int xLatency)` Sets the delay (latency) in millis for iterative events as there are scroll, moved, resized.
`void`	`setLateAutoDelete(boolean xWR)` Sets this object to late auto delete.
`void`	`setLocalValue(java.lang.Object xValue)` Sets the value of the server side part of the node.
`IMoValue`	`setModel(IMoValue xModel)` Sets the model-value which belongs to the widget.
`IMoValue`	`setModelTpl(IMoValue xModel)` Sets the template of the model-value which belongs to the widget.
`void`	`setMultipleParents(boolean xMp)` For internal use only
`void`	`setName(java.lang.String xName)` Sets the name of an element.
`void`	`setNameComparator(java.util.Comparator xComp)` Sets a comparator for sub-name sorting
`void`	`setPostFct(boolean xPostFct)` Enables or disables postFunction handling of widget.
`void`	`setPreFct(boolean xPreFct)` Enables or disables preFunction handling of widget.
`void`	`setPropChanged(boolean xPc)` Sets the property flag of an elements and updates this flag in all parents.
`void`	`setRefresh()` Sets a direct refresh flag of the widget.
`void`	`setRenderIfHidden(boolean xRiH)` The renderIfHidden flag indicates that a widget is rendered always
`IUnTransformer`	`setStringTransformer(IUnTransformer xTrans)` Sets a transformer for the toString method.
`void`	`setStringValue(java.lang.Object xObj)` Sets the value of an element, while the value is converted to a String
`void`	`setSubNodeOwnerShip(boolean xOwner)` Sets the ownership of child-nodes and elements.
`void`	`setTakeMaxSpace(boolean xSpace)` Set a property that indicates that a widget takes all space available in a layout (MARKUP only)
`void`	`setToolTip(java.lang.String xTip)` Sets the tooltip to a widget.
`void`	`setTpl()` Resets to the default template
`void`	`setTpl(java.lang.String xTpl)` Sets a template which may be used by a transformer to generate a String
`void`	`setValue(java.lang.Object xValue)` Sets the value of an element
`void`	`setValueComparator(java.util.Comparator xComp)` Sets a comparator for value sorting
`void`	`setValueOwnerShip(boolean xOwn)` Sets the ownership of the value.
`void`	`setView(IKeView xView)` Sets a view objects to this element.
`void`	`setWidgetValue(java.lang.Object xValue)` Sets the value of the widget.
`void`	`sortByNames(boolean xSortComplete)` Sorts the tree by it's sub-names
`void`	`sortByValues(boolean xSortComplete)` Sorts the tree by it's sub-values
`void`	`toggleHideState()` Toggles the hidden-flag of this node
`void`	`unhide()` Unhide this node
`void`	`unHideAll()` Unhides all children (in deep search manner) and the node itself
`void`	`unHideAllChildren()` Unhides all children (in deep search manner)
`java.lang.Object`	`unRegister()` For internal use only
`void`	`unsetDefaultValue()` Unsets a default value for this element

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Methods inherited from interface de.ug2t.unifiedGui.interfaces.IUnComponent
`toString`

Constructor Detail

UnComponentProxy

public UnComponentProxy(java.lang.String xRefName)

Method Detail

addEventChannel

public void addEventChannel(IUnEventChannel xEvC)

Description copied from interface: IUnComponent

Adds an event channel to the widget.

Specified by:: addEventChannel in interface IUnComponent

Parameters:: xEvC - channel to add

addIndirectListener

public void addIndirectListener(IUnGuiEventListener xListener)

Description copied from interface: IUnComponent

Adds an indirect listener to the widget. The indirect listener is called every time a value of a child of the widget is changed by the gui.

Specified by:: addIndirectListener in interface IUnComponent

Parameters:: xListener - listener to add

addListener

public void addListener(IUnGuiEventListener xListener)

Description copied from interface: IUnComponent

Adds a listener to the widget. The listener is called every time the value of the widget is changed by the gui.

Specified by:: addListener in interface IUnComponent

Parameters:: xListener - listener to add

addPostFct

public void addPostFct(IUnPostDisplayFunction xXpostFct)

Description copied from interface: IUnComponent

Adds a post-display function to the widget. This function is called after the widget has been removed from screen by activating an other page than the one which contains the widget.

Specified by:: addPostFct in interface IUnComponent

Parameters:: xXpostFct - post-display function to add

addPreFct

public void addPreFct(IUnPreDisplayFunction xXpreFct)

Description copied from interface: IUnComponent

Adds a pre-display function to the widget. This function is called before the widget is displayed on screen by activating the page which contains the widget.

Specified by:: addPreFct in interface IUnComponent

Parameters:: xXpreFct - pre-display function to add

consumeEvent

public void consumeEvent()

Description copied from interface: IUnComponent

Consumes the event for this widget. It does not prevent event bubbling!

Specified by:: consumeEvent in interface IUnComponent

deleteFixedSize

public void deleteFixedSize()

Description copied from interface: IUnComponent

Deletes a fixed size setting from a widget

Specified by:: deleteFixedSize in interface IUnComponent

disableSubmit

public void disableSubmit()

Description copied from interface: IUnComponent

Disables the submit Flag of a component

Specified by:: disableSubmit in interface IUnComponent

draw

public void draw()

Description copied from interface: IUnComponent

Initiates a repaint of the widget.

Specified by:: draw in interface IUnComponent

enableSubmit

public void enableSubmit()

Description copied from interface: IUnComponent

Enables the submit flag of a widget. If this flag is enabled a change of the widget value within the gui, or lost of focus leads to a server-side event-dispatch.

Specified by:: enableSubmit in interface IUnComponent

getAppl

public IUnApplication getAppl()

Description copied from interface: IUnComponent

Gets the application which is the owner of this widget

Specified by:: getAppl in interface IUnComponent

Returns:

interface to application object

getBgColor

public java.lang.String getBgColor()

Description copied from interface: IUnComponent

Gets the background-color of a widget.

Specified by:: getBgColor in interface IUnComponent

Returns:

background-color as string

getBorder

public int getBorder()

Description copied from interface: IUnComponent

Gets the the border-style [NO_BORDER || INSETS_BORDER || OTSETS_BORDER || LINE_BORDER]

Specified by:: getBorder in interface IUnComponent

getBorderColor

public java.lang.String getBorderColor()

Description copied from interface: IUnComponent

Gets the the border color

Specified by:: getBorderColor in interface IUnComponent

getBorderWidth

public int getBorderWidth()

Description copied from interface: IUnComponent

Gets the border width in pixel

Specified by:: getBorderWidth in interface IUnComponent

getCssClass

public java.lang.String getCssClass()

Description copied from interface: IUnComponent

Gets the style-sheet class (MARKUP only)

Specified by:: getCssClass in interface IUnComponent

getCurser

public java.lang.String getCurser()

Description copied from interface: IUnComponent

Gets the cursor of the component

Specified by:: getCurser in interface IUnComponent

getEventOnChange

public boolean getEventOnChange()

Description copied from interface: IUnComponent

Returns whether only value-change leads to an event or not

Specified by:: getEventOnChange in interface IUnComponent

Returns:

true indicates that the event is generated every time, false indicates that the event is only generated in case if value-change

getFgColor

public java.lang.String getFgColor()

Description copied from interface: IUnComponent

Gets the foreground-color of a widget.

Specified by:: getFgColor in interface IUnComponent

Returns:

foreground-color as string

getFixedSize

public UnFixedSize getFixedSize()

Description copied from interface: IUnComponent

Gets the fixed size of a widget

Specified by:: getFixedSize in interface IUnComponent

Returns:

a copy of the fixed size object of the widget

getFont

public UnFontDescriptor getFont()

Description copied from interface: IUnComponent

Gets the font which is used to display text within the widget.

Specified by:: getFont in interface IUnComponent

Returns:

font-descriptor

getGlobal

public boolean getGlobal()

Description copied from interface: IUnComponent

Gets the information whether the page is global accessible from client-side or not

Specified by:: getGlobal in interface IUnComponent

Returns:

true indicates global, false indicates page-local

getIterativeEventLatency

public int getIterativeEventLatency()

Description copied from interface: IUnComponent

Gets the latency time

Specified by:: getIterativeEventLatency in interface IUnComponent

getModel

public IMoValue getModel()

Description copied from interface: IUnComponent

Gets the model value which belongs to the widget.

Specified by:: getModel in interface IUnComponent

Returns:

model-value

getModelTpl

public IMoValue getModelTpl()

Description copied from interface: IUnComponent

Gets the template of the model-value which belongs to the widget.

Specified by:: getModelTpl in interface IUnComponent

Returns:

template

getModelTpl

public IMoValue getModelTpl(java.lang.String xTpl)

Description copied from interface: IUnComponent

Gets the special template of the model-value which belongs to the widget.

Specified by:: getModelTpl in interface IUnComponent

Returns:

template

getParentPlugin

public PlBasicComponentAggregat getParentPlugin()

Description copied from interface: IUnComponent

Returns a related plugin parent object if available

Specified by:: getParentPlugin in interface IUnComponent

getPluginPeer

public PlBasicComponentAggregat getPluginPeer()

Description copied from interface: IUnComponent

Returns a related plugin object if available

Specified by:: getPluginPeer in interface IUnComponent

getRenderIfHidden

public boolean getRenderIfHidden()

Description copied from interface: IUnComponent

The renderIfHidden flag indicates that a widget is rendered always

Specified by:: getRenderIfHidden in interface IUnComponent

Returns:

true indicates that widget renders if hidden flag is true false indicates that widget renders not if hidden flag is true value-change

getTakeMaxSpace

public boolean getTakeMaxSpace()

Description copied from interface: IUnComponent

Gets the maxSpace property (MARKUP only)

Specified by:: getTakeMaxSpace in interface IUnComponent

getToolTip

public java.lang.String getToolTip()

Description copied from interface: IUnComponent

Gets the tooltip which has been set to this widget.

Specified by:: getToolTip in interface IUnComponent

Returns:

tooltip text

getUnComponent

public UnComponent getUnComponent()

Description copied from interface: IUnComponent

Gets the associated gui-object which implements all common methods

Specified by:: getUnComponent in interface IUnComponent

Returns:

gui-object

hasCtxMenu

public boolean hasCtxMenu()

Description copied from interface: IUnComponent

Returns wheter the component has a context menu or not, this flag is set once the context menu is added.

Specified by:: hasCtxMenu in interface IUnComponent

isIndirectRefreshed

public boolean isIndirectRefreshed()

Description copied from interface: IUnComponent

Gets the status of the widgets indirect refresh flag

Specified by:: isIndirectRefreshed in interface IUnComponent

Returns:

true if the widgets children value has been refreshed since the last event-dipatch, otherwise false

isRefreshed

public boolean isRefreshed()

Description copied from interface: IUnComponent

Gets the status of the widgets refresh flag

Specified by:: isRefreshed in interface IUnComponent

Returns:

true if the widgets value has been refreshed since the last event-dispatch, otherwise false

isSubmit

public boolean isSubmit()

Description copied from interface: IUnComponent

Disables the submit flag of a widget. If this flag is disabled the widgets value will be stored at client-side until an other widget initiates a server-side event-dispatch

Specified by:: isSubmit in interface IUnComponent

newModelValue

public IMoValue newModelValue(java.lang.String xName,
                              boolean xChilds)

Description copied from interface: IUnComponent

Creates a new model-value from the template.

Specified by:: newModelValue in interface IUnComponent

Parameters:

xName - identifier of the model-value

xChilds - true if all sub-values are created immediately, otherwise false

Returns:

new model-value

newModelValue

public IMoValue newModelValue(java.lang.String xName,
                              boolean xChilds,
                              boolean xFull)

Description copied from interface: IUnComponent

Creates a new model-value from the template.

Specified by:: newModelValue in interface IUnComponent

Parameters:

xName - identifier of the model-value

xChilds - true if all sub-values are created immediately, otherwise false

xFull - true if all sub-values (including the non mandatory ones) are created immediately, otherwise false

Returns:

new model-value

newModelValue

public IMoValue newModelValue(java.lang.String xName,
                              boolean xChilds,
                              boolean xFull,
                              java.lang.String xExclude,
                              boolean xDisableRegister)

Description copied from interface: IUnComponent

Creates a new model-value from the template.

Specified by:: newModelValue in interface IUnComponent

Parameters:

xName - identifier of the model-value

xChilds - true if all sub-values are created immediately, otherwise false

xFull - true if all sub-values (including the non mandatory ones) are created immediately, otherwise false

xExclude - Type to be excluded

xDisableRegister - Disable Registry during object generation

Returns:

new model-value

newModelValue

public IMoValue newModelValue(java.lang.String xName,
                              boolean xChilds,
                              boolean xFull,
                              java.lang.String xExclude)

Description copied from interface: IUnComponent

Creates a new model-value from the template.

Specified by:: newModelValue in interface IUnComponent

Parameters:

xName - identifier of the model-value

xChilds - true if all sub-values are created immediately, otherwise false

xFull - true if all sub-values (including the non mandatory ones) are created immediately, otherwise false

xExclude - Type to be excluded

Returns:

new model-value

remEventChannel

public void remEventChannel(IUnEventChannel xEvC)

Description copied from interface: IUnComponent

Removes an event channle from a widget.

Specified by:: remEventChannel in interface IUnComponent

Parameters:: xEvC - channel to remove

remIndirectListener

public void remIndirectListener(IUnGuiEventListener xListener)

Description copied from interface: IUnComponent

Removes an indirect listener from a widget.

Specified by:: remIndirectListener in interface IUnComponent

Parameters:: xListener - indirect listener to remove

remListener

public void remListener(IUnGuiEventListener xListener)

Description copied from interface: IUnComponent

Removes a listener from a widget.

Specified by:: remListener in interface IUnComponent

Parameters:: xListener - listener to remove

remPostFct

public void remPostFct(IUnPostDisplayFunction xXpostFct)

Description copied from interface: IUnComponent

Removes a post-display function from a widget

Specified by:: remPostFct in interface IUnComponent

Parameters:: xXpostFct - post-display function to remove

remPreFct

public void remPreFct(IUnPreDisplayFunction xXpreFct)

Description copied from interface: IUnComponent

Removes a pre-display function from a widget

Specified by:: remPreFct in interface IUnComponent

Parameters:: xXpreFct - pre-display function to remove

repaint

public void repaint()

Description copied from interface: IUnComponent

Initiates a complete repaint and reinitialise of the widget. This may lead to produce events. If you only want to be rendered call draw.

Specified by:: repaint in interface IUnComponent

requestFocus

public void requestFocus()

Description copied from interface: IUnComponent

Requests the input-focus for the widget.

Specified by:: requestFocus in interface IUnComponent

resetColorSettings

public void resetColorSettings()

Description copied from interface: IUnComponent

Deletes all (foreground/background) color settings of a widget

Specified by:: resetColorSettings in interface IUnComponent

selfRefresh

public void selfRefresh()
                 throws java.lang.Exception

Description copied from interface: IUnComponent

A call to this function make the widget load a new value from an associated data-getter

Specified by:: selfRefresh in interface IUnComponent

Throws:: java.lang.Exception

selfRefreshRecursive

public void selfRefreshRecursive()
                          throws java.lang.Exception

Description copied from interface: IUnComponent

Calls the self-refresh for the complete subtree

Specified by:: selfRefreshRecursive in interface IUnComponent

Throws:: java.lang.Exception

reload

public void reload()
            throws java.lang.Exception

Description copied from interface: IUnComponent

Reloads the data getter

Specified by:: reload in interface IUnComponent

Throws:: java.lang.Exception

reloadRecursive

public void reloadRecursive()
                     throws java.lang.Exception

Description copied from interface: IUnComponent

Reloads the data getter recursive

Specified by:: reloadRecursive in interface IUnComponent

Throws:: java.lang.Exception

setAppl

public void setAppl(IUnApplication xAppl)

Description copied from interface: IUnComponent

Sets the application which owns this widget. In most cases there is no need to use this function.

Specified by:: setAppl in interface IUnComponent

Parameters:: xAppl - interface to application object

setBgColor

public void setBgColor(java.lang.String xCol)

Description copied from interface: IUnComponent

Sets the background-color of the widget.

Specified by:: setBgColor in interface IUnComponent

Parameters:: xCol - background-color as string. For swing channel all constant-names for colors are supported. For MARKUP channel all supported string-values are supported.

setBorder

public void setBorder(int xBorder,
                      java.lang.String xColor,
                      int xWidth)

Description copied from interface: IUnComponent

Sets a border line. To remove a border all the method with (NO_BORDER, "", 0)

Specified by:: setBorder in interface IUnComponent

Parameters:: xBorder - border-style [NO_BORDER || INSETS_BORDER || OTSETS_BORDER || LINE_BORDER]; xColor - border-color; xWidth - border-width in pixel

setCssClass

public void setCssClass(java.lang.String xClass)

Description copied from interface: IUnComponent

Sets the style-sheet class of the widget (MARKUP only)

Specified by:: setCssClass in interface IUnComponent

Parameters:: xClass - style-class

setCursor

public void setCursor(java.lang.String xCursor)

Description copied from interface: IUnComponent

Sets the cursor of the component

Specified by:: setCursor in interface IUnComponent

setDataGetter

public void setDataGetter(ACoDataGetter xDg,
                          java.lang.String xId,
                          boolean xRefresh)

Description copied from interface: IUnComponent

Associates a data-getter object with this widget. The data-getter sets the value of the widget from an external data-source when 'selfRefresh' is called.

Specified by:: setDataGetter in interface IUnComponent

Parameters:: xDg - data-getter; xId - id of the data (-record) to get; xRefresh - true if the widgets refresh flag has to be enabled after refresh, otherwise false

setEventOnChange

public void setEventOnChange(boolean xEvC)

Description copied from interface: IUnComponent

Sets whether only value-change leads to an event or not

Specified by:: setEventOnChange in interface IUnComponent

Parameters:: xEvC - true indicates that the event is generated every time, false indicates that the event is only generated in case if value-change

setFgColor

public void setFgColor(java.lang.String xCol)

Description copied from interface: IUnComponent

Sets the foreground-color of the widget.

Specified by:: setFgColor in interface IUnComponent

Parameters:: xCol - foreground-color as string. For swing channel all constant-names for colors are supported. For MARKUP channel all supported string-values are supported.

setFixedSize

public void setFixedSize(int xW,
                         int xH,
                         int xType)

Description copied from interface: IUnComponent

Applies a fixed size to a widget

Specified by:: setFixedSize in interface IUnComponent

Parameters:: xW - new size width; xH - new size height

setFont

public void setFont(UnFontDescriptor xFont)

Description copied from interface: IUnComponent

Sets the font which is used to display text within the widget.

Specified by:: setFont in interface IUnComponent

Parameters:: xFont - font-descriptor

setGlobal

public void setGlobal(boolean xGlobal)

Description copied from interface: IUnComponent

Sets a widget as global. This means that the widget can be accessed from client-side whether the containing page is active or not

Specified by:: setGlobal in interface IUnComponent

Parameters:: xGlobal - true indicates global, false indicates page-local

setIndirectRefresh

public void setIndirectRefresh()

Description copied from interface: IUnComponent

Sets a indirect refresh flag of the widget. Due to this the connected indirect event-listeners will be called during the next event-dispatch. After the event-dispatch this flag is set to false. The meaning of the indirect refresh flag is that not the widgets value has been changed but one of the widgets children value has been changed since the last event-dispatch.

Specified by:: setIndirectRefresh in interface IUnComponent

setIterativeEventLatency

public void setIterativeEventLatency(int xLatency)

Description copied from interface: IUnComponent

Sets the delay (latency) in millis for iterative events as there are scroll, moved, resized. For Example: A delay of 200 ms means that a scroll event is passed to the server after 200ms, presumed that there is no further scroll event generated during this time. This feature is able to reduce network trafic significant.

Specified by:: setIterativeEventLatency in interface IUnComponent

Parameters:: xLatency - time in millis

setLocalValue

public void setLocalValue(java.lang.Object xValue)

Description copied from interface: IKeTreeNode

Sets the value of the server side part of the node.

Specified by:: setLocalValue in interface IKeTreeNode
Specified by:: setLocalValue in interface IUnComponent

Parameters:: xValue - new node-value

setModel

public IMoValue setModel(IMoValue xModel)

Description copied from interface: IUnComponent

Sets the model-value which belongs to the widget.

Specified by:: setModel in interface IUnComponent

Parameters:

xModel - new model-value

Returns:

previous model-value

setModelTpl

public IMoValue setModelTpl(IMoValue xModel)

Description copied from interface: IUnComponent

Sets the template of the model-value which belongs to the widget.

Specified by:: setModelTpl in interface IUnComponent

Parameters:

xModel - new template

Returns:

previous template

setPostFct

public void setPostFct(boolean xPostFct)

Description copied from interface: IUnComponent

Enables or disables postFunction handling of widget. Postfunction are executed by default. For performance-reasons disabling this feature may be reasonable

Specified by:: setPostFct in interface IUnComponent

Parameters:: xPostFct - true enables handling, false disables

setPreFct

public void setPreFct(boolean xPreFct)

Description copied from interface: IUnComponent

Enables or disables preFunction handling of widget. Prefunction are executed by default. For performance-reasons disabling this feature may be reasonable

Specified by:: setPreFct in interface IUnComponent

Parameters:: xPreFct - true enables handling, false disables

setRefresh

public void setRefresh()

Description copied from interface: IUnComponent

Sets a direct refresh flag of the widget. Due to this the connected event-listeners will be called during the next event-dispatch. After the event-dispatch this flag is set to false

Specified by:: setRefresh in interface IUnComponent

setRenderIfHidden

public void setRenderIfHidden(boolean xRiH)

Description copied from interface: IUnComponent

The renderIfHidden flag indicates that a widget is rendered always

Specified by:: setRenderIfHidden in interface IUnComponent

Parameters:: xRiH - true render widget if hidden flag is true false do not render widget if hidden flag is true

setTakeMaxSpace

public void setTakeMaxSpace(boolean xSpace)

Description copied from interface: IUnComponent

Set a property that indicates that a widget takes all space available in a layout (MARKUP only)

Specified by:: setTakeMaxSpace in interface IUnComponent

Parameters:: xSpace -

setToolTip

public void setToolTip(java.lang.String xTip)

Description copied from interface: IUnComponent

Sets the tooltip to a widget. A tooltip is a small window which contains a short explanation. This window pops up if the mouse-cursor stay above the widget for some seconds.

Specified by:: setToolTip in interface IUnComponent

Parameters:: xTip - tooltip text

setValue

public void setValue(java.lang.Object xValue)

Description copied from interface: IKeTreeElement

Sets the value of an element

Specified by:: setValue in interface IKeTreeElement
Specified by:: setValue in interface IUnComponent

Parameters:: xValue - new value

setWidgetValue

public void setWidgetValue(java.lang.Object xValue)

Description copied from interface: IUnComponent

Sets the value of the widget. Listeners are called as a side-effect. The behaviour of events is similar in Swing and Web/MARKUP

Specified by:: setWidgetValue in interface IUnComponent

Parameters:: xValue - new widget-value

addElement

public KeTreeElement addElement(java.lang.String xName,
                                KeTreeElement xNode)

Description copied from interface: IKeTreeNode

Adds a child-elelemt into this node. The child-elelemt has to have a name. Not unique name are permitted. The getSubElement (xName,... method returns the last node which has been inserted with a not unique name.

Specified by:: addElement in interface IKeTreeNode

Parameters:

xName - name of the element to insert

xNode - node to insert

Returns:

if xName is not unique the current elelemt with this name is returned. Else null is returned.

addElement

public KeTreeElement addElement(java.lang.String xName,
                                KeTreeElement xNode,
                                KeTreeElement xBehind)

Description copied from interface: IKeTreeNode

Adds a child-element into this node behind a given child-node or child-element. The child-element has to have a name. Not unique name are permitted. The getSubElement (xName,... method returns the last node which has been inserted with a not unique name.

Specified by:: addElement in interface IKeTreeNode

Parameters:

xName - name of the element to insert

xNode - element to insert

xBehind - node ore element behind which the new node is inserted

Returns:

if xName is not unique the current node with this name is returned. Else null is returned.

addElement

public KeTreeElement addElement(java.lang.String xName,
                                KeTreeElement xNode,
                                int xIdx)

Description copied from interface: IKeTreeNode

Adds a child-element into this node at a given index. The child-element has to have a name. Not unique name are permitted. The getSubElement (xName,... method returns the last node which has been inserted with a not unique name.

Specified by:: addElement in interface IKeTreeNode

Parameters:

xName - name of the element to insert

xNode - element to insert

xIdx - index where the node is inserted

Returns:

if xName is not unique the current node with this name is returned. Else null is returned.

addElementLocal

public KeTreeElement addElementLocal(java.lang.String xName,
                                     KeTreeElement xNode)

Description copied from interface: IKeTreeNode

Specified by:: addElementLocal in interface IKeTreeNode

Parameters:

xName - name of the element to insert

xNode - node to insert

Returns:

if xName is not unique the current elelemt with this name is returned. Else null is returned.

addNode

public KeTreeNode addNode(java.lang.String xName,
                          KeTreeNode xNode)

Description copied from interface: IKeTreeNode

Adds a child-node into this node. The child-node has to have a name. Not unique name are permitted. The getSubNode (xName,... method returns the last node which has been inserted with a not unique name.

Specified by:: addNode in interface IKeTreeNode

Parameters:

xName - name of the node to insert

xNode - node to insert

Returns:

if xName is not unique the current node with this name is returned. Else null is returned.

addNode

public KeTreeNode addNode(java.lang.String xName,
                          KeTreeNode xNode,
                          int xIdx)

Description copied from interface: IKeTreeNode

Adds a child-node into this node at a given index. The child-node has to have a name. Not unique name are permitted. The getSubNode (xName,... method returns the last node which has been inserted with a not unique name.

Specified by:: addNode in interface IKeTreeNode

Parameters:

xName - name of the node to insert

xNode - node to insert

xIdx - index where the node is inserted

Returns:

if xName is not unique the current node with this name is returned. Else null is returned.

addNode

public KeTreeNode addNode(java.lang.String xName,
                          KeTreeNode xNode,
                          KeTreeElement xBehind)

Description copied from interface: IKeTreeNode

Adds a child-node into this node behind a given child-node or child-element. The child-node has to have a name. Not unique name are permitted. The getSubNode (xName,... method returns the last node which has been inserted with a not unique name.

Specified by:: addNode in interface IKeTreeNode

Parameters:

xName - name of the node to insert

xNode - node to insert

xBehind - node ore element behind which the new node is inserted

Returns:

if xName is not unique the current node with this name is returned. Else null is returned.

addNodeLocal

public KeTreeNode addNodeLocal(java.lang.String xName,
                               KeTreeNode xNode)

Description copied from interface: IKeTreeNode

Specified by:: addNodeLocal in interface IKeTreeNode

Parameters:

xName - name of the node to insert

xNode - node to insert

Returns:

if xName is not unique the current node with this name is returned. Else null is returned.

clear

public void clear()

Description copied from interface: IKeTreeNode

Deletes the (sub)tree which is represented by this node, but excludes this node and all subtrees of this node are kept alive

Specified by:: clear in interface IKeTreeNode

clearAndRelease

public void clearAndRelease()

Description copied from interface: IKeTreeNode

Deletes the (sub)tree which is represented by this node, but excludes this node

Specified by:: clearAndRelease in interface IKeTreeNode

contains

public boolean contains(KeTreeElement xObj)

Description copied from interface: IKeTreeNode

Tests if a node/element is inserted in the tree.

Specified by:: contains in interface IKeTreeNode

Parameters:

xObj - node/element to test

Returns:

true if the node/element was found, otherwise false

deepSubNodeVector

public void deepSubNodeVector(java.util.ArrayList xL_vect)

Description copied from interface: IKeTreeNode

Inserts all nodes of the (sub)tree which is represented by this node into an array

Specified by:: deepSubNodeVector in interface IKeTreeNode

Parameters:: xL_vect - array whre the nodes and elements are inserted

disable

public void disable()

Description copied from interface: IKeTreeElement

Disables the element

Specified by:: disable in interface IKeTreeElement
Specified by:: disable in interface IKeTreeNode

enable

public void enable()

Description copied from interface: IKeTreeElement

Enables the element

Specified by:: enable in interface IKeTreeElement
Specified by:: enable in interface IKeTreeNode

getAllDisabled

public void getAllDisabled(java.util.ArrayList xRes)

Description copied from interface: IKeTreeElement

Gets all disabled nodes/elements and includes ths node/element

Specified by:: getAllDisabled in interface IKeTreeElement
Specified by:: getAllDisabled in interface IKeTreeNode

Parameters:: xRes - ArrayList with result

getAllEnabled

public void getAllEnabled(java.util.ArrayList xRes)

Description copied from interface: IKeTreeElement

Gets all enabled nodes/elements and includes ths node/element

Specified by:: getAllEnabled in interface IKeTreeElement
Specified by:: getAllEnabled in interface IKeTreeNode

Parameters:: xRes - ArrayList with result

getAllSubCount

public int getAllSubCount(boolean xCountHide)

Description copied from interface: IKeTreeElement

Returns 0 because tree_elements can not hold any children

Specified by:: getAllSubCount in interface IKeTreeElement
Specified by:: getAllSubCount in interface IKeTreeNode

Parameters:

xCountHide - indicates whether hidden childs are counted or not

Returns:

child count

getAllSubNames

public java.util.ArrayList getAllSubNames()

Description copied from interface: IKeTreeNode

Gets all child-node and child element names

Specified by:: getAllSubNames in interface IKeTreeNode

Returns:

list with all node and element names

getAllSubs

public java.util.ArrayList getAllSubs()

Description copied from interface: IKeTreeNode

Gets all child-nodes and child elements

Specified by:: getAllSubs in interface IKeTreeNode

Returns:

list with all nodes and elements

getByPath

public KeTreeElement getByPath(java.lang.String xPath)

Description copied from interface: IKeTreeNode

Gets a sub-node or sub-element by its path. The path is similar to a path in a directory tree. Names are separated by / or :

Specified by:: getByPath in interface IKeTreeNode

Parameters:

xPath - path of the node or element

Returns:

sub-node or element with the given path of null if no node or element could be found

getChildCount

public int getChildCount()

Description copied from interface: IKeTreeElement

Returns 0 because tree_elements can not hold any children

Specified by:: getChildCount in interface IKeTreeElement
Specified by:: getChildCount in interface IKeTreeNode

Returns:

child count

getDeepSubNodeIt

public java.util.Iterator getDeepSubNodeIt()

Description copied from interface: IKeTreeNode

Creates an iterator over all nodes of the (sub)tree which is represented by this node

Specified by:: getDeepSubNodeIt in interface IKeTreeNode

Returns:

iterator

getElementAt

public KeTreeElement getElementAt(int xIdx)

Description copied from interface: IKeTreeNode

Gets a child-node or chld-element at a given index. The internal list of child-nodes and child-elements represents the order of inserting.

Specified by:: getElementAt in interface IKeTreeNode

Parameters:

xIdx - child-node or child-element index

Returns:

child-node or elelemt. If the index is not valid an exception is rised

getNodeAt

public KeTreeNode getNodeAt(int xIdx)

Description copied from interface: IKeTreeNode

Gets a child-node or chld-element at a given index. The internal list of child-nodes and child-elements represents the order of inserting. The only difference between this method and getElementAt is an internal cast operation

Specified by:: getNodeAt in interface IKeTreeNode

Parameters:

xIdx - child-node or child-element index

Returns:

child-node or elelemt. If the index is not valid an exception is rised

getSub

public KeTreeElement getSub(java.lang.String xName)

Description copied from interface: IKeTreeNode

Gets a sub-node or sub-element by its name. If the name is not unique the last node or element of this name which has been inserted is returned

Specified by:: getSub in interface IKeTreeNode

Parameters:

xName - name of the node or element

Returns:

sub-node or element with the given name of null if no node of this name could be found

getSubCount

public int getSubCount()

Description copied from interface: IKeTreeNode

Similar to getChildCount

Specified by:: getSubCount in interface IKeTreeNode

getSubElement

public KeTreeElement getSubElement(java.lang.String xName)

Description copied from interface: IKeTreeNode

Gets a sub-element by its name. If the name is not unique the last element of this name which has been inserted is returned

Specified by:: getSubElement in interface IKeTreeNode

Parameters:

xName - name of the element

Returns:

sub-element with the given name of null if no node of this name could be found

getSubIterator

public java.util.Iterator getSubIterator()

Description copied from interface: IKeTreeNode

Creates an iterator over all child-nodes and child-elements

Specified by:: getSubIterator in interface IKeTreeNode

Returns:

iterator

getSubNameIterator

public java.util.Iterator getSubNameIterator()

Description copied from interface: IKeTreeNode

Creates an iterator over all child-node and child-element names

Specified by:: getSubNameIterator in interface IKeTreeNode

Returns:

iterator

getSubNode

public KeTreeNode getSubNode(java.lang.String xName)

Description copied from interface: IKeTreeNode

Gets a sub-node by its name. If the name is not unique the last node of this name which has been inserted is returned

Specified by:: getSubNode in interface IKeTreeNode

Parameters:

xName - name of the node

Returns:

sub-node with the given name of null if no node of this name could be found

hide

public void hide()

Description copied from interface: IKeTreeNode

Hide this node

Specified by:: hide in interface IKeTreeNode

hideAll

public void hideAll()

Description copied from interface: IKeTreeNode

Hides all children (in deep search manner) and the node itself

Specified by:: hideAll in interface IKeTreeNode

hideAllChildren

public void hideAllChildren()

Description copied from interface: IKeTreeNode

Hides all children (in deep search manner)

Specified by:: hideAllChildren in interface IKeTreeNode

hideLevel

public void hideLevel(int xLevel)

Description copied from interface: IKeTreeNode

Hides all children (in deep search manner) starting by the specified depth

Specified by:: hideLevel in interface IKeTreeNode

Parameters:: xLevel - depth to start

indexOf

public int indexOf(KeTreeElement xEl)

Description copied from interface: IKeTreeNode

Gets the index of a child-node or child-element with the list of child-nodes. The internal list of child-nodes and child-elements represents the order of inserting.

Specified by:: indexOf in interface IKeTreeNode

Parameters:

xEl - node or element to search

Returns:

index of the given node or -1 if the node is not a child-node

isHidden

public boolean isHidden()

Description copied from interface: IKeTreeNode

Returns the hidden-flag of this node

Specified by:: isHidden in interface IKeTreeNode

Returns:: idden flag

isOwner

public boolean isOwner()

Description copied from interface: IKeTreeNode

Returns the ownership flag

Specified by:: isOwner in interface IKeTreeNode

Returns:

ownership

isParentHidden

public boolean isParentHidden()

Description copied from interface: IKeTreeNode

Returns whether a parent is hidden or not

Specified by:: isParentHidden in interface IKeTreeNode

Returns:: true indicates hidden, otherwise false

releaseSubs

public void releaseSubs()

Description copied from interface: IKeTreeElement

For internal use only

Specified by:: releaseSubs in interface IKeTreeElement
Specified by:: releaseSubs in interface IKeTreeNode

removeElement

public KeTreeElement removeElement(java.lang.String xName)

Description copied from interface: IKeTreeNode

Removes a element with a given name

Specified by:: removeElement in interface IKeTreeNode

Parameters:

xName - name of the element to remove

Returns:

the removed element

removeElement

public KeTreeElement removeElement(KeTreeElement xNode)

Description copied from interface: IKeTreeNode

Removes a given element

Specified by:: removeElement in interface IKeTreeNode

Parameters:

xNode - element to remove

Returns:

the removed element

removeNode

public KeTreeNode removeNode(java.lang.String xName)

Description copied from interface: IKeTreeNode

Removes a node with a given name

Specified by:: removeNode in interface IKeTreeNode

Parameters:

xName - name of the node to remove

Returns:

the removed node

removeNode

public KeTreeNode removeNode(KeTreeNode xNode)

Description copied from interface: IKeTreeNode

Removes a given node

Specified by:: removeNode in interface IKeTreeNode

Parameters:

xNode - node-object to remove

Returns:

the remove node

removeNodeLocal

public KeTreeNode removeNodeLocal(java.lang.String xName)

Description copied from interface: IKeTreeNode

Removes a node with a given name

Specified by:: removeNodeLocal in interface IKeTreeNode

Parameters:

xName - name of the node to remove

Returns:

the removed node

removeNodeLocal

public KeTreeNode removeNodeLocal(KeTreeNode xNode)

Description copied from interface: IKeTreeNode

Removes a given node

Specified by:: removeNodeLocal in interface IKeTreeNode

Parameters:

xNode - node-object to remove

Returns:

the remove node

resetPropertyChangeFlag

public void resetPropertyChangeFlag()

Description copied from interface: IKeTreeNode

This method resets the property change flag recursively.

Specified by:: resetPropertyChangeFlag in interface IKeTreeNode

resetRecursive

public java.lang.Object resetRecursive()

Description copied from interface: IKeTreeElement

For internal use only

Specified by:: resetRecursive in interface IKeTreeElement
Specified by:: resetRecursive in interface IKeTreeNode

Returns:

the old value of this node

setNameComparator

public void setNameComparator(java.util.Comparator xComp)

Description copied from interface: IKeTreeNode

Sets a comparator for sub-name sorting

Specified by:: setNameComparator in interface IKeTreeNode

Parameters:: xComp - Comparator

setSubNodeOwnerShip

public void setSubNodeOwnerShip(boolean xOwner)

Description copied from interface: IKeTreeNode

Sets the ownership of child-nodes and elements. If true a delete of the parent node deletes all children as well

Specified by:: setSubNodeOwnerShip in interface IKeTreeNode

Parameters:: xOwner -

setValueComparator

public void setValueComparator(java.util.Comparator xComp)

Description copied from interface: IKeTreeNode

Sets a comparator for value sorting

Specified by:: setValueComparator in interface IKeTreeNode

Parameters:: xComp - Comparator

sortByNames

public void sortByNames(boolean xSortComplete)

Description copied from interface: IKeTreeNode

Sorts the tree by it's sub-names

Specified by:: sortByNames in interface IKeTreeNode

Parameters:: xSortComplete - true indicates a full deep sort, false sorts only direct children of this node

sortByValues

public void sortByValues(boolean xSortComplete)

Description copied from interface: IKeTreeNode

Sorts the tree by it's sub-values

Specified by:: sortByValues in interface IKeTreeNode

Parameters:: xSortComplete - true indicates a full deep sort, false sorts only direct children of this node

toggleHideState

public void toggleHideState()

Description copied from interface: IKeTreeNode

Toggles the hidden-flag of this node

Specified by:: toggleHideState in interface IKeTreeNode

unHideAll

public void unHideAll()

Description copied from interface: IKeTreeNode

Unhides all children (in deep search manner) and the node itself

Specified by:: unHideAll in interface IKeTreeNode

unHideAllChildren

public void unHideAllChildren()

Description copied from interface: IKeTreeNode

Unhides all children (in deep search manner)

Specified by:: unHideAllChildren in interface IKeTreeNode

unhide

public void unhide()

Description copied from interface: IKeTreeNode

Unhide this node

Specified by:: unhide in interface IKeTreeNode

addPropertyChangedListener

public void addPropertyChangedListener(IKePropertyChangeListener xListen)

Description copied from interface: IKeTreeElement

Adds a property changed listener. This listener is called whenever a property of the tree element has been change. Derived classes should use the 'setPropChanged(boolean xPc)' method to inform the the super class about the change!

Specified by:: addPropertyChangedListener in interface IKeTreeElement

Parameters:: xListen - listener object to add

delete

public void delete()
            throws java.lang.Exception

Description copied from interface: IKeRegisteredObject

Deletes an object from the registry

Specified by:: delete in interface IKeRegisteredObject
Specified by:: delete in interface IKeTreeElement

Throws:: java.lang.Exception

disableThis

public void disableThis()

Description copied from interface: IKeTreeElement

Disables the element

Specified by:: disableThis in interface IKeTreeElement

enableThis

public void enableThis()

Description copied from interface: IKeTreeElement

Enables the element

Specified by:: enableThis in interface IKeTreeElement

execView

public java.lang.Object execView()

Description copied from interface: IKeTreeElement

Produces a view from this node.

Specified by:: execView in interface IKeTreeElement

getAllParentGenerations

public void getAllParentGenerations(java.util.ArrayList xToAdd)

Description copied from interface: IKeTreeElement

Gets all (parent)node above this node

Specified by:: getAllParentGenerations in interface IKeTreeElement

getDefaultValue

public java.lang.Object getDefaultValue()

Description copied from interface: IKeTreeElement

Returns the default value

Specified by:: getDefaultValue in interface IKeTreeElement

getLastParentNode

public KeTreeNode getLastParentNode()

Description copied from interface: IKeTreeElement

Gets the last parent node of this element. An element can be inserted in more than one parent node! The parent which has been added first is returned by this function.

Specified by:: getLastParentNode in interface IKeTreeElement

Returns:

last parent

getMultipleParents

public boolean getMultipleParents()

Description copied from interface: IKeTreeElement

For internal use only

Specified by:: getMultipleParents in interface IKeTreeElement

getMyPropChanged

public boolean getMyPropChanged()

Description copied from interface: IKeTreeElement

Gets the myProperty flag of an element. This flag is true if a property is changed directly

Specified by:: getMyPropChanged in interface IKeTreeElement

getName

public java.lang.String getName()

Description copied from interface: IKeTreeElement

Gets the name of this element

Specified by:: getName in interface IKeTreeElement

Returns:

name

getParentGeneration

public KeTreeElement getParentGeneration(int xGeneration)

Description copied from interface: IKeTreeElement

Gets a (parent)node above this node

Specified by:: getParentGeneration in interface IKeTreeElement

Parameters:

xGeneration - generation of the parent - the parent generation 0 the parent of the parent is generation 1 and so on

Returns:

parent node

getParentNode

public KeTreeNode getParentNode()

Description copied from interface: IKeTreeElement

Gets the parent node of this element. An element can be inserted in more than one parent node! The parent which has been added last is returned by this function.

Specified by:: getParentNode in interface IKeTreeElement

Returns:

parent

getParentNodeCount

public int getParentNodeCount()

Description copied from interface: IKeTreeElement

Gets the depth of the tree from the root node to this element

Specified by:: getParentNodeCount in interface IKeTreeElement

Returns:

depth

getParents

public java.util.Iterator getParents()

Description copied from interface: IKeTreeElement

Returns an iterator over all parent nodes of this element

Specified by:: getParents in interface IKeTreeElement

Returns:

iterator

getParentsList

public java.util.ArrayList getParentsList()

Description copied from interface: IKeTreeElement

Returns a list with all parent nodes of this element

Specified by:: getParentsList in interface IKeTreeElement

Returns:

iterator

getPath

public java.lang.String getPath()

Description copied from interface: IKeTreeElement

Returns the absolute path of this node

Specified by:: getPath in interface IKeTreeElement

Returns:

path

getPropChanged

public boolean getPropChanged()

Description copied from interface: IKeTreeElement

Gets the property flag of an element.This flag is true if a property is changed directly or the property of any child had changed

Specified by:: getPropChanged in interface IKeTreeElement

getPropertyChangedListeners

public java.util.ArrayList getPropertyChangedListeners()

Description copied from interface: IKeTreeElement

Returns the list with all property changed listeners

Specified by:: getPropertyChangedListeners in interface IKeTreeElement

Returns:: list

getRootNode

public KeTreeElement getRootNode()

Description copied from interface: IKeTreeElement

Gets the root node of a tree

Specified by:: getRootNode in interface IKeTreeElement

Returns:

root node

getValue

public java.lang.Object getValue()

Description copied from interface: IKeTreeElement

Gets the value of the element

Specified by:: getValue in interface IKeTreeElement

Returns:

value

getView

public IKeView getView()

Description copied from interface: IKeTreeElement

Gets the view of this node

Specified by:: getView in interface IKeTreeElement

Returns:

view object

isChildOf

public boolean isChildOf(KeTreeNode xNode)

Description copied from interface: IKeTreeElement

Returns whether this node is part of the subtree of xNode or not

Specified by:: isChildOf in interface IKeTreeElement

Returns:

true, false

isDefSet

public boolean isDefSet()

Description copied from interface: IKeTreeElement

Returns whether a default is set or not

Specified by:: isDefSet in interface IKeTreeElement

Returns:: true indicates default set, otherwise false

isDisabled

public boolean isDisabled()

Description copied from interface: IKeTreeElement

Returns the disabled flag of this element

Specified by:: isDisabled in interface IKeTreeElement

Returns:

disabled flag

isParentDisabled

public boolean isParentDisabled()

Description copied from interface: IKeTreeElement

Returns whether a parent is disabled or not

Specified by:: isParentDisabled in interface IKeTreeElement

Returns:: true indicates disabled, otherwise false

removePropertyChangedListener

public void removePropertyChangedListener(IKePropertyChangeListener xListen)

Description copied from interface: IKeTreeElement

Removes a property changed listener.

Specified by:: removePropertyChangedListener in interface IKeTreeElement

Parameters:: xListen - listener object to remove

reset

public java.lang.Object reset()

Description copied from interface: IKeTreeElement

Resets the elements value to the default value

Specified by:: reset in interface IKeTreeElement

Returns:

old value

setDefaultValue

public void setDefaultValue(java.lang.Object xObj)

Description copied from interface: IKeTreeElement

Sets a default value for this element

Specified by:: setDefaultValue in interface IKeTreeElement

Parameters:: xObj - default value

setMultipleParents

public void setMultipleParents(boolean xMp)

Description copied from interface: IKeTreeElement

For internal use only

Specified by:: setMultipleParents in interface IKeTreeElement

setName

public void setName(java.lang.String xName)

Description copied from interface: IKeTreeElement

Sets the name of an element. If an element is inserted in a node, the name can not be changed

Specified by:: setName in interface IKeTreeElement

Parameters:: xName - new name

setPropChanged

public void setPropChanged(boolean xPc)

Description copied from interface: IKeTreeElement

Sets the property flag of an elements and updates this flag in all parents. This flag is used internally e.g. for cache implementations

Specified by:: setPropChanged in interface IKeTreeElement

Parameters:: xPc - true indicates a change

setStringTransformer

public IUnTransformer setStringTransformer(IUnTransformer xTrans)

Description copied from interface: IKeTreeElement

Sets a transformer for the toString method. A transformer is responsible for the transformation of objects. In this case it is used to generate a string representation of this element

Specified by:: setStringTransformer in interface IKeTreeElement

Parameters:

xTrans - new transformer

Returns:

old transformer

setStringValue

public void setStringValue(java.lang.Object xObj)

Description copied from interface: IKeTreeElement

Sets the value of an element, while the value is converted to a String

Specified by:: setStringValue in interface IKeTreeElement

Parameters:: xObj - new value

setTpl

public void setTpl(java.lang.String xTpl)

Description copied from interface: IKeTreeElement

Sets a template which may be used by a transformer to generate a String

Specified by:: setTpl in interface IKeTreeElement

Parameters:: xTpl - string template

setTpl

public void setTpl()

Description copied from interface: IKeTreeElement

Resets to the default template

Specified by:: setTpl in interface IKeTreeElement

setValueOwnerShip

public void setValueOwnerShip(boolean xOwn)

Description copied from interface: IKeTreeElement

Sets the ownership of the value. If true a delete of the element deletes the value as well

Specified by:: setValueOwnerShip in interface IKeTreeElement

Parameters:: xOwn -

setView

public void setView(IKeView xView)

Description copied from interface: IKeTreeElement

Sets a view objects to this element. The view generates a visual representation of this node

Specified by:: setView in interface IKeTreeElement

Parameters:: xView - view object

unsetDefaultValue

public void unsetDefaultValue()

Description copied from interface: IKeTreeElement

Unsets a default value for this element

Specified by:: unsetDefaultValue in interface IKeTreeElement

isDeleted

public boolean isDeleted()

Description copied from interface: IKeRegisteredObject

For internal use only

Specified by:: isDeleted in interface IKeRegisteredObject

isGlobal

public boolean isGlobal()

Description copied from interface: IKeRegisteredObject

Returns whether this object is registered globally or not

Specified by:: isGlobal in interface IKeRegisteredObject

isLocal

public boolean isLocal()

Description copied from interface: IKeRegisteredObject

Returns whether this object is registered localy or not

Specified by:: isLocal in interface IKeRegisteredObject

isRegistered

public boolean isRegistered()

Description copied from interface: IKeRegisteredObject

Returns whether this object is registered or not

Specified by:: isRegistered in interface IKeRegisteredObject

register

public int register(java.lang.String xName)

Description copied from interface: IKeRegisteredObject

Registers an object in the currently running threads namespace which is derived from KeRegisteredObject

Specified by:: register in interface IKeRegisteredObject

Parameters:: xName - unique name of the object and must not be null

registerGlobal

public int registerGlobal(java.lang.String xName)

Description copied from interface: IKeRegisteredObject

Registers an object in the global namespace which is derived from KeRegisteredObject

Specified by:: registerGlobal in interface IKeRegisteredObject

Parameters:: xName - unique name of the object

setEarlyAutoDelete

public void setEarlyAutoDelete(boolean xWR)

Description copied from interface: IKeRegisteredObject

Sets this object to early auto delete. This means the object is deleted automatically when no reference points to it except the one in the registry.

Specified by:: setEarlyAutoDelete in interface IKeRegisteredObject

setLateAutoDelete

public void setLateAutoDelete(boolean xWR)

Description copied from interface: IKeRegisteredObject

Sets this object to late auto delete. This means the object is deleted automatically when no reference points to it except the one in the registry and the memory is low.

Specified by:: setLateAutoDelete in interface IKeRegisteredObject

unRegister

public java.lang.Object unRegister()

Description copied from interface: IKeRegisteredObject

For internal use only

Specified by:: unRegister in interface IKeRegisteredObject

getIndirectListeners

public java.util.ArrayList getIndirectListeners()

Description copied from interface: IUnComponent

Gets an ArraList with all indirect listeners

Specified by:: getIndirectListeners in interface IUnComponent

Returns:: listeners

getListeners

public java.util.ArrayList getListeners()

Description copied from interface: IUnComponent

Gets an ArraList with all listeners

Specified by:: getListeners in interface IUnComponent

Returns:: listeners

ensureUnhide

public void ensureUnhide()

Description copied from interface: IKeTreeElement

Unhides all parents of this element

Specified by:: ensureUnhide in interface IKeTreeElement

getDataGetter

public ACoDataGetter getDataGetter()

Description copied from interface: IUnComponent

Returns the current data getter.

Specified by:: getDataGetter in interface IUnComponent

Returns:: current data getter

pushValues

public void pushValues()
                throws java.lang.Exception

Description copied from interface: IUnComponent

pushes the values back to the source of the data-getter

Specified by:: pushValues in interface IUnComponent

Throws:: java.lang.Exception

pushValuesRecursive

public void pushValuesRecursive()
                         throws java.lang.Exception

Description copied from interface: IUnComponent

pushes the values back to the source of the data-getter recursively

Specified by:: pushValuesRecursive in interface IUnComponent

Throws:: java.lang.Exception

receiveValues

public void receiveValues()
                   throws java.lang.Exception

Description copied from interface: IUnComponent

A call to this function make the widget load a new value from an associated data-getter sets only the value of the component

Specified by:: receiveValues in interface IUnComponent

Throws:: java.lang.Exception

receiveValuesRecursive

public void receiveValuesRecursive()
                            throws java.lang.Exception

Description copied from interface: IUnComponent

Calls the receiveValue for the complete subtree

Specified by:: receiveValuesRecursive in interface IUnComponent

Throws:: java.lang.Exception

clearListeners

public void clearListeners()

Description copied from interface: IUnComponent

Removes all listeners

Specified by:: clearListeners in interface IUnComponent

clearIndirectListeners

public void clearIndirectListeners()

Description copied from interface: IUnComponent

Removes all indirect listeners

Specified by:: clearIndirectListeners in interface IUnComponent

Overview

Package

Class

Tree

Deprecated

Index

Help

WidgetServer

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

de.ug2t.unifiedGui Class UnComponentProxy

UnComponentProxy

addEventChannel

addIndirectListener

addListener

addPostFct

addPreFct

consumeEvent

deleteFixedSize

disableSubmit

draw

enableSubmit

getAppl

getBgColor

getBorder

getBorderColor

getBorderWidth

getCssClass

getCurser

getEventOnChange

getFgColor

getFixedSize

getFont

getGlobal

getIterativeEventLatency

getModel

getModelTpl

getModelTpl

getParentPlugin

getPluginPeer

getRenderIfHidden

getTakeMaxSpace

getToolTip

getUnComponent

hasCtxMenu

isIndirectRefreshed

isRefreshed

isSubmit

newModelValue

newModelValue

newModelValue

newModelValue

remEventChannel

remIndirectListener

remListener

remPostFct

remPreFct

repaint

requestFocus

resetColorSettings

selfRefresh

selfRefreshRecursive

reload

reloadRecursive

setAppl

setBgColor

setBorder

setCssClass

setCursor

setDataGetter

setEventOnChange

setFgColor

setFixedSize

setFont

setGlobal

setIndirectRefresh

setIterativeEventLatency

setLocalValue

setModel

setModelTpl

setPostFct

setPreFct

setRefresh

setRenderIfHidden

setTakeMaxSpace

setToolTip

setValue

setWidgetValue

addElement

addElement

de.ug2t.unifiedGui
Class UnComponentProxy