com.oberon.ooql.sdk
Class FormUserItem

java.lang.Object
  com.oberon.ooql.sdk.FormUserItem

public class FormUserItem
extends java.lang.Object

Form - Item instance associated to a specific user

Since:

4.0

Version:

5.0

Nested Class Summary

static class	FormUserItem.Value Value element: combines the effective value with display value
static class	FormUserItem.ValueComparator Comparator for sorting the values based on the display value

Constructor Summary

FormUserItem(Item item, java.util.Vector<java.lang.Object> filterArgs, Framework framework)
Constructor

FormUserItem(Item item, java.util.Vector<java.lang.Object> filterArgs, Framework framework, java.util.Hashtable<java.lang.String,java.lang.Integer> counters)
Constructor

Method Summary

static FormUserItem	fromXML(org.jdom.Element rootElement) Create a FormUserItem object from XML element tree
int	getFieldType() Get the Item - field type
java.lang.String	getFormat() Get the Output/Input format
double	getHeight() Get the Item height
Item	getItem() Deprecated.
java.lang.String	getItemFormName() Get the name of Item in Form control
java.lang.String	getItemValue() Get the Item value or parameters
java.lang.String	getLabel() Return the Item label
java.lang.String	getName() Return the Item name
java.util.Vector<FormUserItem.Value>	getRanges() Get the Item ranges
int	getType() Get the Item type
java.lang.String	getUnitMeasure() Get the Item unit measure
FormUserItem.Value	getValue() Get the Item value
double	getWidth() Get the Item width
boolean	hasRangeProgram() Check if the Item - field has a own range program
boolean	isDisabled() Check if the Item is disabled for the framework user
boolean	isEditable() Check if the Item is editable by framework user
boolean	isFieldMultipleSelection() Check if the Item - field is enabled to multiple selection.
boolean	isRequired() Check if the Item is required for the framework user
void	setEditable(boolean editable) Set whether or not the Item is editable by framework user
void	setLabel(java.lang.String label) Set the Item label
void	setRangeProgram(boolean hasProgram) Set if field has a own range program
void	setRanges(java.util.Vector<FormUserItem.Value> ranges) Set the Item ranges
void	setUnitMeasure(java.lang.String um) Set the Item unit measure
void	setValue(FormUserItem.Value value) Set the Item value
void	setValue(java.lang.String value) Set the Item value
java.lang.String	toString() Show the Form Item status for the current framework user
org.jdom.Element	toXML() Return the FormUserItem object properties as XML element tree

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

FormUserItem

public FormUserItem(Item item,
                    java.util.Vector<java.lang.Object> filterArgs,
                    Framework framework)
             throws OberonException

Constructor

Parameters:

item - the Form Item

filterArgs - extra arguments used to compute the user access

framework - the user framework

Throws:

OberonException

FormUserItem

public FormUserItem(Item item,
                    java.util.Vector<java.lang.Object> filterArgs,
                    Framework framework,
                    java.util.Hashtable<java.lang.String,java.lang.Integer> counters)

Constructor

Parameters:

item - the Form Item

filterArgs - extra arguments used to compute the user access

framework - the user framework

counters - administrative object synch counters (if null read them from database)

Method Detail

setEditable

public void setEditable(boolean editable)

Set whether or not the Item is editable by framework user

isEditable

public boolean isEditable()

Check if the Item is editable by framework user

isRequired

public boolean isRequired()

Check if the Item is required for the framework user

isDisabled

public boolean isDisabled()

Check if the Item is disabled for the framework user

setValue

public void setValue(java.lang.String value)

Set the Item value

setValue

public void setValue(FormUserItem.Value value)

Set the Item value

Since:

4.1

getValue

public FormUserItem.Value getValue()

Get the Item value

setUnitMeasure

public void setUnitMeasure(java.lang.String um)

Set the Item unit measure

Since:

4.1

getUnitMeasure

public java.lang.String getUnitMeasure()

Get the Item unit measure

Since:

4.1

setRanges

public void setRanges(java.util.Vector<FormUserItem.Value> ranges)

Set the Item ranges

Since:

4.1

getRanges

public java.util.Vector<FormUserItem.Value> getRanges()

Get the Item ranges

Since:

4.1

getItem

@Deprecated
public Item getItem()

Deprecated.

Return the Form Item definition

getName

public java.lang.String getName()

Return the Item name

Since:

4.1

setLabel

public void setLabel(java.lang.String label)

Set the Item label

Since:

4.1

getLabel

public java.lang.String getLabel()

Return the Item label

Since:

4.1

getType

public int getType()

Get the Item type

Since:

4.1

getFieldType

public int getFieldType()

Get the Item - field type

Since:

4.1

getFormat

public java.lang.String getFormat()

Get the Output/Input format

Since:

4.1

getItemValue

public java.lang.String getItemValue()

Get the Item value or parameters

Since:

4.1

getWidth

public double getWidth()

Get the Item width

Returns:

the Item width value

Since:

4.1

getHeight

public double getHeight()

Get the Item height

Returns:

the Item height value

Since:

4.1

isFieldMultipleSelection

public boolean isFieldMultipleSelection()

Check if the Item - field is enabled to multiple selection.

Returns:

the multiple selection flag

Since:

4.1

setRangeProgram

public void setRangeProgram(boolean hasProgram)

Set if field has a own range program

Since:

4.1

hasRangeProgram

public boolean hasRangeProgram()

Check if the Item - field has a own range program

Since:

4.1

getItemFormName

public java.lang.String getItemFormName()

Get the name of Item in Form control

Since:

4.1

toString

public java.lang.String toString()

Show the Form Item status for the current framework user

Overrides:

toString in class java.lang.Object

toXML

public org.jdom.Element toXML()

Return the FormUserItem object properties as XML element tree

fromXML

public static FormUserItem fromXML(org.jdom.Element rootElement)
                            throws OberonException

Create a FormUserItem object from XML element tree

Throws:

OberonException

Since:

4.1