de.uplanet.lucy.server.rtcache
Interface ControlInfo


@Scriptable
public interface ControlInfo

Information about controls.

Version:
$Revision: 78151 $

Method Summary
 java.lang.String getAppGuid()
          Gets GUID of application.
 java.lang.String getControlName()
          Gets the name of the control.
 de.uplanet.lucy.types.IControlType getControlType()
          Gets the type of control.
 java.lang.String getDataGroupGuid()
          Gets the data group guid.
 java.lang.String getDefault()
          Gets the default value.
 java.lang.String getDefaultTitle()
          Get the default title of this control.
 de.uplanet.lucy.constants.DEFAULT_TYPE getDefaultType()
          Gets the default type.
 java.lang.String getFieldGuid()
          Gets GUID of field.
 de.uplanet.lucy.types.UP_TYPE getFieldType()
          Get the data type of the bound data field.
 java.lang.String getGuid()
          Gets GUID of control.
 java.util.List<java.lang.String> getLanguages()
          Get the languages that are supported by this control
 java.lang.String getPageGuid()
          Gets GUID of page.
 de.uplanet.lucy.server.property.ControlPropertyCollection getProperties()
          Get the convert string (contains for example local number format settings)
 de.uplanet.lucy.types.IControlType getReferredControlType()
          Gets the referenced data type.
 java.lang.String getSysIdent()
          Gets the default system identifier.
 java.lang.String getTitle(java.lang.String p_strTitle)
          Get the control title for the given language.
 java.util.Map<java.lang.String,java.lang.String> getTitles()
          Get the control's language specific titles.
 java.lang.String getValueListDgGuid()
          Get the GUID of value list data group.
 boolean isEditControl()
          Determines, if control is a edit control.
 boolean isReadOnly()
          Determine, if control is read only.
 boolean shouldOrgStructEncode()
           
 boolean shouldPipeEncode()
           
 boolean supportsLanguage(java.lang.String p_strLang)
          Determines, if given language is supported.
 

Method Detail

getGuid

java.lang.String getGuid()
Gets GUID of control.

Returns:
The control GUID.

getAppGuid

java.lang.String getAppGuid()
Gets GUID of application.

Returns:
The application GUID.

getPageGuid

java.lang.String getPageGuid()
Gets GUID of page.

Returns:
The page GUID.

getFieldGuid

java.lang.String getFieldGuid()
Gets GUID of field.

Returns:
The field GUID.

isReadOnly

boolean isReadOnly()
Determine, if control is read only.

Returns:
True, if control is read only, else false.

getControlType

de.uplanet.lucy.types.IControlType getControlType()
Gets the type of control.

Returns:
The control type (value of IControlType).

getProperties

de.uplanet.lucy.server.property.ControlPropertyCollection getProperties()
Get the convert string (contains for example local number format settings)

Returns:
The convert string.

isEditControl

boolean isEditControl()
Determines, if control is a edit control.

Returns:
true if the control is an edit control, or false otherwise.

getControlName

java.lang.String getControlName()
Gets the name of the control.

Returns:
The control name.

getValueListDgGuid

java.lang.String getValueListDgGuid()
Get the GUID of value list data group.

Returns:
The value list data group GUID.

getDefaultType

de.uplanet.lucy.constants.DEFAULT_TYPE getDefaultType()
Gets the default type.

Returns:
The default type (value ofde.uplanet.lucy.util.IcLucyDefaultTypes).

getDefault

java.lang.String getDefault()
Gets the default value.

Returns:
The default string.

getSysIdent

java.lang.String getSysIdent()
Gets the default system identifier.

Returns:
The system identifier.

getReferredControlType

de.uplanet.lucy.types.IControlType getReferredControlType()
Gets the referenced data type.

Returns:
The referred control type (value of IControlType).

getDataGroupGuid

java.lang.String getDataGroupGuid()
Gets the data group guid.

Returns:
The data group GUID.

getFieldType

de.uplanet.lucy.types.UP_TYPE getFieldType()
Get the data type of the bound data field.

Returns:
The data type of the bound data field.

shouldOrgStructEncode

boolean shouldOrgStructEncode()
Returns:

shouldPipeEncode

boolean shouldPipeEncode()
Returns:

getTitle

java.lang.String getTitle(java.lang.String p_strTitle)
Get the control title for the given language.

Parameters:
p_strLang - A language identifier.
Returns:
The language-specific control name, or the default name if the requested name does not exist (could be null).

getDefaultTitle

java.lang.String getDefaultTitle()
Get the default title of this control.

Returns:
The default title of this control (could be null).

getTitles

java.util.Map<java.lang.String,java.lang.String> getTitles()
Get the control's language specific titles.

Returns:
The language specific titles (not null).

supportsLanguage

boolean supportsLanguage(java.lang.String p_strLang)
Determines, if given language is supported.

Returns:
true if the given language is supported by this control, or false otherwise.

getLanguages

java.util.List<java.lang.String> getLanguages()
Get the languages that are supported by this control

Returns:
The identifiers of the supported languages (not null).


Last updated: 2011-01-27
Copyright 2000-2010 United Planet. All Rights Reserved.