|
OBEROn SDK | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.oberon.ooql.sdk.OBBase
com.oberon.ooql.sdk.AdminComponent
com.oberon.ooql.sdk.Item
public class Item
Form - Item: represents a user Form
element.
Field Summary | |
---|---|
static int |
DISABLED_OPTION
The Field disabled flag index inside the Option Set |
static int |
FIELDTYPE_CHECKBOX
HTML Check Box |
static int |
FIELDTYPE_DATE
HTML Date Picker |
static int |
FIELDTYPE_HIDDEN
HTML Hidden Input |
static int |
FIELDTYPE_length
|
static int |
FIELDTYPE_LISTBOX
HTML Double List Box |
static int |
FIELDTYPE_POPUP
PopUp selector |
static int |
FIELDTYPE_RADIO
HTML Radio Button |
static int |
FIELDTYPE_SELECT
HTML Combo Box |
static int |
FIELDTYPE_TEXT
HTML Text Input |
static int |
FIELDTYPE_TEXTAREA
HTML Textarea |
static int |
FORMTYPE_CLASS
Form Type - Object class default form |
static int |
FORMTYPE_DEFAULT
Form Type - Administrative element |
static int |
FORMTYPE_DYNAMIC
Form Type - Dynamically created by program |
static int |
FORMTYPE_length
|
static int |
ITEMACCESS_DISABLED
Disabled access condition |
static int |
ITEMACCESS_EDITABLE
Editable access condition |
static int |
ITEMACCESS_Length
|
static int |
ITEMACCESS_REQUIRED
Required access condition |
static int |
ITEMACCESS_VISIBLE
Visible access condition |
static int |
ITEMTYPE_ACTION
HTML Action Input (Parameter used by the Form action program) |
static int |
ITEMTYPE_BASIC
Object Basic Field |
static int |
ITEMTYPE_BUTTON
HTML Button |
static int |
ITEMTYPE_EMBED
Embedded object |
static int |
ITEMTYPE_FIELD
Input field related to main class |
static int |
ITEMTYPE_FORM
Include another form |
static int |
ITEMTYPE_GETLINK
Static text - extract data from links |
static int |
ITEMTYPE_GETOBJ
Static text - extract data from object |
static int |
ITEMTYPE_HIDDEN
Hidden value |
static int |
ITEMTYPE_HREF
HTML Link |
static int |
ITEMTYPE_IMAGE
Image |
static int |
ITEMTYPE_LABEL
Static label |
static int |
ITEMTYPE_length
|
static int |
ITEMTYPE_NAVIGATE
Navigate table |
static int |
ITEMTYPE_SECTION
Section separator |
static int |
ITEMTYPE_SPACER
Line Break |
static int |
ITEMTYPE_XFIELD
Input field related to secondary classes |
static int |
MULTIPLE_OPTION
The Multiple selection flag index inside the Option Set |
static int |
REQUIRED_OPTION
The Field required flag index inside the Option Set |
Fields inherited from class com.oberon.ooql.sdk.AdminComponent |
---|
bsOptions |
Constructor Summary | |
---|---|
Item()
|
|
Item(java.lang.String name)
|
Method Summary | |
---|---|
static java.lang.String |
accessToString(java.util.BitSet accessFlags,
java.lang.String delim)
Convert the access flags to the OOQL format |
void |
addAccessProgram(Trigger program)
Add a trigger to compute the Item access |
void |
compareUpdate(Item refItem,
boolean checkImage,
Framework framework)
Return/apply the OOQL command to update this Item object and let it become equals to another reference object. |
boolean |
equals(Item item)
Compare two Items |
void |
fromXML(org.jdom.Element rootElement)
Load the Item properties from XML element tree |
static java.lang.String |
getAccessAsString(int accessType)
Convert the access type to the OOQL format |
static java.lang.String |
getAccessEvent(int accessType)
Convert the access type to the OOQL access trigger format (visible / editable ...) |
static int |
getAccessId(java.lang.String access)
Convert the access type from the OOQL format to the internal id |
Trigger |
getAccessProgramByEvent(java.lang.String event)
Get trigger to compute a specific access for this Item |
java.util.Vector<Trigger> |
getAccessPrograms()
Get triggers to compute the Item access |
java.lang.String |
getAccessProgramsAsString(java.lang.String delim)
Get triggers to compute the Item access as String |
ActorAccess |
getActorAccess(java.lang.String actorType,
java.lang.String actorName)
Get the Item accesses for the given actor |
boolean |
getActorAccess(java.lang.String actorType,
java.lang.String actorName,
int accessType)
Get the actor access to this Item for a specific operation |
java.util.Vector<ActorAccess> |
getActorAccesses()
Get the all actor accesses for this Item |
java.util.Vector<java.lang.String> |
getActors()
Get all actors enabled for this Item |
java.util.Vector<java.lang.String> |
getActors(java.lang.String actorType)
Get all actors enabled for this Item filtered by type |
java.lang.String |
getApplication()
Get the application Menu name. |
java.lang.String |
getChangeCommand()
Return the OOQL command to update this Item with the modified properties. |
java.util.BitSet |
getCommunityAccess()
Get the Item accesses for the community |
boolean |
getCommunityAccess(int accessType)
Get the community access to this Item for a specific operation |
java.lang.String |
getCreateCommand(boolean force)
[Inherited but not used] |
java.lang.String |
getCreateCommand(java.lang.String operator,
java.lang.String refItem)
Return the OOQL command to add this Item with the settled properties to a Form |
int |
getFieldType()
Get the Item - field type |
java.lang.String |
getFieldTypeAsString()
Get the Item - field type in OOQL format |
static java.lang.String |
getFieldTypeAsString(int type)
Convert the Item - field type to OOQL format |
static int |
getFieldTypeFromString(java.lang.String htmlType)
Convert Item - field type from OOQL (html) format |
Form |
getForm()
Get the related Form |
java.lang.String |
getFormat()
Get the Output/Input format |
int |
getFormType()
Get the Item - form type |
java.lang.String |
getFormTypeAsString()
Get the Item - form type in OOQL format |
static java.lang.String |
getFormTypeAsString(int type)
Convert the Item - form type to OOQL format |
static int |
getFormTypeFromString(java.lang.String formType)
Convert Item - form type from OOQL format |
double |
getHeight()
Get the Item height |
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 |
getProperty(java.lang.String propertyName,
java.util.Vector<java.lang.Object> filterArgs,
java.lang.String token,
Framework framework)
Get a property for this Item item by its OOQL identifier |
java.lang.String |
getSaveCommand(boolean force)
[Inherited but not used] |
java.util.Vector<?> |
getTargetNames(java.lang.String composedName,
java.util.Vector<java.lang.Object> filterArgs,
Framework framework)
Return a Vector of administrative object names extracted by using an OOQL selector |
int |
getType()
Get the Item type |
java.lang.String |
getTypeAsString()
Get the Item type in OOQL format |
static java.lang.String |
getTypeAsString(int type)
Convert the Item type in OOQL format |
static int |
getTypeFromString(java.lang.String itemType)
Convert Item type from OOQL format |
double |
getWidth()
Get the Item width |
org.jdom.Element |
getXMLAssignmentList(java.lang.String actor)
Return the Item Assignment access as XML element tree |
org.jdom.Element |
getXMLCommunity()
Return the Item community access as XML element tree |
org.jdom.Element |
getXMLTeamList(java.lang.String actor)
Return the Item Team access as XML element tree |
org.jdom.Element |
getXMLUserList(java.lang.String actor)
Return the Item User access as XML element tree |
boolean |
hasAccess(int accessType,
java.util.Vector<java.lang.Object> filterArgs,
Framework framework)
Check if the framework user has access to this Item |
boolean |
hasAccess(int accessType,
java.util.Vector<java.lang.Object> filterArgs,
Framework framework,
java.util.Hashtable<java.lang.String,java.lang.Integer> counters)
Check if the framework user has access to this Item |
boolean |
isFieldDisabled()
Deprecated. |
boolean |
isFieldMultipleSelection()
Check if the Item - field is enabled to multiple selection. |
boolean |
isFieldRequired()
Deprecated. |
boolean |
isImageChanged()
Check if the item image is changed |
void |
removeAccessProgram(Trigger program)
Remove a Item access trigger |
void |
removeActorAccess(java.lang.String actorType,
java.lang.String actorName)
Revoke the Item access to a specific actor |
void |
setAccessPrograms(java.util.Vector<Trigger> programs)
Set triggers to compute the Item access |
void |
setActorAccess(java.lang.String actorType,
java.lang.String actorName,
java.util.BitSet accessFlags)
Set the Item accesses for a specific actor |
void |
setActorAccess(java.lang.String actorType,
java.lang.String actorName,
int accessType,
boolean accessFlag)
Set the Item access for a specific actor |
void |
setAllActorAccess(java.lang.String actorType,
java.lang.String actorName)
Give the full Item access to a specific actor |
void |
setAllCommunityAccess()
Give the full Item access to the community |
void |
setCommunityAccess(java.util.BitSet accessFlags)
Set the Item accesses for the community |
void |
setCommunityAccess(int accessType,
boolean accessFlag)
Set the Item access for the community |
void |
setFieldMultipleSelection(boolean multipleFlag)
Set the multiple selection flag for this Item - field. |
void |
setFieldType(int type)
Set the Item - field type. |
void |
setForm(Form form)
Link the Item with the related Form |
void |
setFormat(java.lang.String format)
Set the Output/Input format. |
void |
setFormType(int type)
Set the Item - form type. |
void |
setHeight(double height)
Set the Item height. |
void |
setItemAs(int type,
java.lang.String parameters)
Set the Item type and parameters. |
void |
setItemAsAction(java.lang.String parameters)
Set the Item as a hidden value. |
void |
setItemAsBasic(java.lang.String parameters)
Set the Item as a ObjectObj basic field. |
void |
setItemAsButton(java.lang.String parameters)
Set the Item as html button. |
void |
setItemAsEmbed(java.lang.String parameters)
Set the Item as a HTML embedded object. |
void |
setItemAsExtraField(java.lang.String fieldName)
Set the Item as HTML input field related to an extra ObjectObj/Link Field |
void |
setItemAsField(java.lang.String fieldName)
Set the Item as HTML input field directly related to an ObjectObj/Link Field |
void |
setItemAsFormInclude(java.lang.String parameters)
Set the Item as a hidden value. |
void |
setItemAsGetLink(java.lang.String ooqlSelector)
Set an OOQL Link selector for the Item content. |
void |
setItemAsGetObject(java.lang.String ooqlSelector)
Set an OOQL ObjectObj selector for the Item content. |
void |
setItemAsHidden(java.lang.String parameters)
Set the Item as a hidden value. |
void |
setItemAsHRef(java.lang.String url)
Set the Item as a HTML anchor. |
void |
setItemAsImage(java.lang.String src)
Set the Item as a HTML image. |
void |
setItemAsLabel(java.lang.String label)
Set the Item as a label. |
void |
setItemAsNavigate(java.lang.String parameters)
Set the Item as a navigator table. |
void |
setItemAsSectionHeader(java.lang.String sectionLabel)
Set the Item as a section header. |
void |
setItemAsSpacer()
Set the Item as a spacer. |
void |
setNoCommunityAccess()
Revoke the Item access to the community |
void |
setWidth(double width)
Set the Item width. |
java.lang.String |
toString()
Return the Item properties as a single String |
org.jdom.Element |
toXML(boolean getImage,
boolean fullDump,
Framework framework)
Return the Item properties as XML element tree |
org.jdom.Element |
toXML(Framework framework)
Return the Item properties as XML element tree |
void |
updateAccessPrograms(java.util.Vector<Trigger> programs)
Update the access programs on the basis of a given list |
void |
updateActorAccess(java.util.Vector<ActorAccess> accesses)
Update the execute access on the basis of a given list |
Methods inherited from class com.oberon.ooql.sdk.AdminComponent |
---|
checkChangeName, getAdminType, getCommonProperty, getCommonTargetNames, getCrtDate, getDescription, getEditBasicCommand, getImage, getImageData, getImageFile, getModDate, getModUser, getName, getOldName, hasImage, setCrtDate, setDescription, setImage, setImageData, setImageFile, setModDate, setModUser, setName, toCommonXML, toXML |
Methods inherited from class com.oberon.ooql.sdk.OBBase |
---|
addChange, addUniqueChange, ChangesFromXML, ChangesToXML, getChanges, getChangesAsString, getId, isLinked, removeChange, resetChanges, setId, setLinked |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final int MULTIPLE_OPTION
public static final int DISABLED_OPTION
public static final int REQUIRED_OPTION
public static final int ITEMACCESS_VISIBLE
public static final int ITEMACCESS_EDITABLE
public static final int ITEMACCESS_REQUIRED
public static final int ITEMACCESS_DISABLED
public static final int ITEMACCESS_Length
public static final int ITEMTYPE_FIELD
public static final int ITEMTYPE_GETOBJ
public static final int ITEMTYPE_GETLINK
public static final int ITEMTYPE_SECTION
public static final int ITEMTYPE_SPACER
public static final int ITEMTYPE_HREF
public static final int ITEMTYPE_LABEL
public static final int ITEMTYPE_IMAGE
public static final int ITEMTYPE_EMBED
public static final int ITEMTYPE_HIDDEN
public static final int ITEMTYPE_NAVIGATE
public static final int ITEMTYPE_BASIC
public static final int ITEMTYPE_BUTTON
public static final int ITEMTYPE_ACTION
public static final int ITEMTYPE_FORM
public static final int ITEMTYPE_XFIELD
public static final int ITEMTYPE_length
public static final int FIELDTYPE_TEXT
public static final int FIELDTYPE_TEXTAREA
public static final int FIELDTYPE_SELECT
public static final int FIELDTYPE_CHECKBOX
public static final int FIELDTYPE_RADIO
public static final int FIELDTYPE_DATE
public static final int FIELDTYPE_HIDDEN
public static final int FIELDTYPE_POPUP
public static final int FIELDTYPE_LISTBOX
public static final int FIELDTYPE_length
public static final int FORMTYPE_DEFAULT
public static final int FORMTYPE_CLASS
public static final int FORMTYPE_DYNAMIC
public static final int FORMTYPE_length
Constructor Detail |
---|
public Item()
public Item(java.lang.String name) throws OberonException
name
- the name of the administrative object
OberonException
- if the name contains invalid charactersMethod Detail |
---|
public boolean isImageChanged()
public void setForm(Form form)
Form
public Form getForm()
Form
public java.lang.String getApplication()
Menu
name.
public void setItemAsField(java.lang.String fieldName)
fieldName
- the ObjectObj
/Link
Field
namepublic void setItemAsExtraField(java.lang.String fieldName)
fieldName
- the ObjectObj
/Link
Field
namepublic void setItemAsLabel(java.lang.String label)
label
- the label valuepublic void setItemAsSectionHeader(java.lang.String sectionLabel)
sectionLabel
- the section header labelpublic void setItemAsSpacer()
public void setItemAsHRef(java.lang.String url)
url
- the link url (it can contains substitution macros)public void setItemAsImage(java.lang.String src)
src
- the image source URL (it can contains substitution macros)public void setItemAsEmbed(java.lang.String parameters)
parameters
- the embed parameterspublic void setItemAsHidden(java.lang.String parameters)
public void setItemAsNavigate(java.lang.String parameters)
public void setItemAsBasic(java.lang.String parameters)
ObjectObj
basic field.
public void setItemAsButton(java.lang.String parameters)
public void setItemAsAction(java.lang.String parameters)
public void setItemAsFormInclude(java.lang.String parameters)
public void setItemAsGetObject(java.lang.String ooqlSelector)
ObjectObj
selector for the Item content.
ooqlSelector
- ObjectObj selector in OOQL format (example: description , field['FieldName'],... )public void setItemAsGetLink(java.lang.String ooqlSelector)
Link
selector for the Item content.
ooqlSelector
- Link selector in OOQL format (example: to.name , field['FieldName'],... )public void setItemAs(int type, java.lang.String parameters)
type
- the Item typeparameters
- Item parameterspublic int getType()
public static java.lang.String getTypeAsString(int type)
public java.lang.String getTypeAsString()
public static int getTypeFromString(java.lang.String itemType)
public java.lang.String getItemValue()
public java.lang.String getItemFormName()
public void setWidth(double width)
width
- the Item widthpublic double getWidth()
public void setHeight(double height)
height
- the item height. The meaning of this value depends on the
HTML control type: for example for selection fields this
represents the number of visible options.public double getHeight()
public void setFormat(java.lang.String format) throws OberonException
Program
sObjectObj
is in the StageName statusObjectObj
is in the StageName status
OberonException
public java.lang.String getFormat()
public void setCommunityAccess(int accessType, boolean accessFlag)
accessType
- the access type ( ITEMACCESS_VISIBLE
/ ITEMACCESS_EDITABLE
)accessFlag
- true to enable / false to disable the accesspublic void setAllCommunityAccess()
public void setNoCommunityAccess()
public void setCommunityAccess(java.util.BitSet accessFlags)
public boolean getCommunityAccess(int accessType)
accessType
- the access type ( ITEMACCESS_VISIBLE
/ ITEMACCESS_EDITABLE
)public java.util.BitSet getCommunityAccess()
public static int getAccessId(java.lang.String access)
public static java.lang.String getAccessAsString(int accessType)
public static java.lang.String getAccessEvent(int accessType)
public static java.lang.String accessToString(java.util.BitSet accessFlags, java.lang.String delim)
delim
- the access separator stringpublic void setActorAccess(java.lang.String actorType, java.lang.String actorName, java.util.BitSet accessFlags)
actorType
- the actor type: can be ActorAccess.USER
, ActorAccess.TEAM
, ActorAccess.ASSIGNMENT
actorName
- the actor namepublic void setActorAccess(java.lang.String actorType, java.lang.String actorName, int accessType, boolean accessFlag)
actorType
- the actor type: can be ActorAccess.USER
, ActorAccess.TEAM
, ActorAccess.ASSIGNMENT
actorName
- the actor nameaccessType
- the access type ( ITEMACCESS_VISIBLE
/ ITEMACCESS_EDITABLE
)accessFlag
- true to enable / false to disable the accesspublic void setAllActorAccess(java.lang.String actorType, java.lang.String actorName)
actorType
- the actor type: can be ActorAccess.USER
, ActorAccess.TEAM
, ActorAccess.ASSIGNMENT
actorName
- the actor namepublic void removeActorAccess(java.lang.String actorType, java.lang.String actorName)
actorType
- the actor type: can be ActorAccess.USER
, ActorAccess.TEAM
, ActorAccess.ASSIGNMENT
actorName
- the actor namepublic void updateActorAccess(java.util.Vector<ActorAccess> accesses)
accesses
- list of ActorAccess
espublic boolean getActorAccess(java.lang.String actorType, java.lang.String actorName, int accessType)
actorType
- the actor type: can be ActorAccess.USER
, ActorAccess.TEAM
, ActorAccess.ASSIGNMENT
actorName
- the actor nameaccessType
- the access type ( ITEMACCESS_VISIBLE
/ ITEMACCESS_EDITABLE
)public ActorAccess getActorAccess(java.lang.String actorType, java.lang.String actorName)
actorType
- the actor type: can be ActorAccess.USER
, ActorAccess.TEAM
, ActorAccess.ASSIGNMENT
actorName
- the actor namepublic java.util.Vector<java.lang.String> getActors(java.lang.String actorType)
actorType
- the actor type: can be ActorAccess.USER
, ActorAccess.TEAM
, ActorAccess.ASSIGNMENT
or empty
public java.util.Vector<java.lang.String> getActors()
public java.util.Vector<ActorAccess> getActorAccesses()
ActorAccess
espublic void setAccessPrograms(java.util.Vector<Trigger> programs)
programs
- Vector of Program
s ( or access Trigger
s )public void addAccessProgram(Trigger program) throws OberonException
program
- the access Trigger
OberonException
public void removeAccessProgram(Trigger program)
addAccessProgram(Trigger)
public void updateAccessPrograms(java.util.Vector<Trigger> programs) throws OberonException
programs
- list of Trigger
s
OberonException
public java.util.Vector<Trigger> getAccessPrograms()
Trigger
spublic java.lang.String getAccessProgramsAsString(java.lang.String delim)
delim
- the trigger data separatorpublic Trigger getAccessProgramByEvent(java.lang.String event)
event
- is the OOQL event type ( visible / editable )public boolean hasAccess(int accessType, java.util.Vector<java.lang.Object> filterArgs, Framework framework)
accessType
- the access type ( ITEMACCESS_VISIBLE
/ ITEMACCESS_EDITABLE
)filterArgs
- extra arguments used to compute the Item accesspublic boolean hasAccess(int accessType, java.util.Vector<java.lang.Object> filterArgs, Framework framework, java.util.Hashtable<java.lang.String,java.lang.Integer> counters)
accessType
- the access type ( ITEMACCESS_VISIBLE
/ ITEMACCESS_EDITABLE
)filterArgs
- extra arguments used to compute the Item accesscounters
- administrative object synch counters (if null read them from database)public void setFieldType(int type)
type
- the field typepublic int getFieldType()
public static java.lang.String getFieldTypeAsString(int type)
public java.lang.String getFieldTypeAsString()
public static int getFieldTypeFromString(java.lang.String htmlType)
@Deprecated public boolean isFieldDisabled()
@Deprecated public boolean isFieldRequired()
public void setFieldMultipleSelection(boolean multipleFlag)
multipleFlag
- true to enable multiple selection for the fieldpublic boolean isFieldMultipleSelection()
public void setFormType(int type)
type
- the form typepublic int getFormType()
public static java.lang.String getFormTypeAsString(int type)
public java.lang.String getFormTypeAsString()
public static int getFormTypeFromString(java.lang.String formType)
public java.lang.String getProperty(java.lang.String propertyName, java.util.Vector<java.lang.Object> filterArgs, java.lang.String token, Framework framework)
getProperty
in class OBBase
propertyName
- OOQL property identifier/name (example: format , label ...)filterArgs
- extra arguments used to compute propertiestoken
- separator token for complex propertiesframework
- the current framework
public java.util.Vector<?> getTargetNames(java.lang.String composedName, java.util.Vector<java.lang.Object> filterArgs, Framework framework)
getTargetNames
in class OBBase
composedName
- OOQL property identifier/name (example: user , team ... )filterArgs
- extra arguments used to compute propertiesframework
- the current framework
public boolean equals(Item item)
public java.lang.String toString()
toString
in class java.lang.Object
public org.jdom.Element getXMLCommunity()
public org.jdom.Element getXMLUserList(java.lang.String actor)
User
access as XML element tree
public org.jdom.Element getXMLTeamList(java.lang.String actor)
Team
access as XML element tree
public org.jdom.Element getXMLAssignmentList(java.lang.String actor)
Assignment
access as XML element tree
public org.jdom.Element toXML(Framework framework)
framework
- the current frameworkpublic org.jdom.Element toXML(boolean getImage, boolean fullDump, Framework framework)
fullDump
- true to include detailed informationframework
- the current frameworkpublic void fromXML(org.jdom.Element rootElement)
fromXML
in class AdminComponent
public java.lang.String getCreateCommand(boolean force)
public java.lang.String getSaveCommand(boolean force)
public java.lang.String getCreateCommand(java.lang.String operator, java.lang.String refItem)
Form
operator
- OOQL syntax position (example: "append" , "addbefore" ....)refItem
- the name of the reference Itempublic java.lang.String getChangeCommand()
public void compareUpdate(Item refItem, boolean checkImage, Framework framework) throws OberonException
refItem
- the reference Item objectframework
- the current framework
OberonException
fromXML(Element)
|
OBEROn SDK | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |