|
HATS 7.5.1 Web API ReferencePublicly accessible methods not documented here are for IBM internal use only and may change in a future release of the product. |
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.ibm.hats.transform.TransformationConstants
public class TransformationConstants
This class defines constants related to host screen transformation.
During screen transformation, component and widget objects reference "context attributes,"
which are an object that extends the ContextAttributes object.
ContextAttributes objects are objects which help the component and widget understand
what environment they are being used within and also provide access to objects such as
the HTTP session, request, response, etc.
Static constants declared in this class (and marked as being available as a context attribute) can be used as a key into the context attributes Hashtable.
Note: it is preferred that context attributes be referenced through their API in the proper
ContextAttributes class, rather than using the variables in this class. The
variables marked as context attributes in this class have been kept primarily for legacy support
(and reference the values of the corresponding ContextAttribute constant).
| Field Summary | |
|---|---|
static String |
ATTR_APPLY_RENDERING_RULES
Flag (of type Boolean) to indicate whether rendering rules (global rules) are to be applied in this screen transformation (available as a context attribute) |
static String |
ATTR_ARABIC_ORIENTATION
Internal constant related to orientation (Bidi-only) |
static String |
ATTR_AUTO_ENTER
HTML input tag attribute name for an "auto enter" (5250 only) field |
static String |
ATTR_CLASS_LOADER
ClassLoader object for the associated Studio project (available as a context attribute) |
static String |
ATTR_CLASS_SETTINGS
Hashtable of application class settings hashtables (each <class> defined in the <classSettings> is available in this table) (available as a context attribute) |
static String |
ATTR_CODEPAGE
Internal constant related to code page (Bidi-only) |
static String |
ATTR_COMPONENT_CLASS_NAME
Fully-qualified component class name (available as a context attribute) |
static String |
ATTR_CONTEXT
|
static String |
ATTR_DIRECTION
Internal constant related to component orientation , found in class settings |
static String |
ATTR_DIRECTION_TEXT
Internal constant related to text direction for widgets, found in class settings |
static String |
ATTR_DIRECTION_WIDGET
Internal constant related to widget orientation , found in class settings |
static String |
ATTR_DISABLE_AUTO_ADVANCE
HTML input tag attribute to disable auto advance for that input field |
static String |
ATTR_ENTRY_REQUIRED
HTML input tag attribute name for an "entry required" (5250 only) field |
static String |
ATTR_FIELD_EXIT_REQUIRED
HTML input tag attribute name for a "field exit required" (5250 only) field |
static String |
ATTR_FILL_REQUIRED
HTML input tag attribute name for a "fill required" (5250 only) field |
static String |
ATTR_FORM_ID
Form ID (applicable in a portal environment) (available as a context attribute) |
static String |
ATTR_GLOBAL_VARIABLES
Global variables Hashtable (available as a context attribute) |
static String |
ATTR_HTTP_REQUEST
HTTP servlet request (available as a context attribute) |
static String |
ATTR_HTTP_RESPONSE
HTTP servlet response (available as a context attribute) |
static String |
ATTR_IN_COMPACT_RENDERING
Flag (of type Boolean) indicating whether screen transformation is being performed via default rendering for smaller screens (available as a context attribute) |
static String |
ATTR_IN_COMPONENT_PREVIEW
Flag (of type Boolean) indicating whether screen transformation is being performed for the purpose of a component preview (probably within the Insert Host Component Wizard) (available as a context attribute) |
static String |
ATTR_IN_DEFAULT_RENDERING
Flag (of type Boolean) indicating whether screen transformation is being performed via default rendering (available as a context attribute) |
static String |
ATTR_IN_GLOBAL_RULES
Flag of type Boolean indicating if component list is in a Global Rules context |
static String |
ATTR_IN_SCREEN_COMBINATION
Flag of type Boolean indicating if component list is in Screen Combination context |
static String |
ATTR_IN_STUDIO
Flag (of type Boolean) to indicate whether the code is running inside the Studio development environment (available as a context attribute) |
static String |
ATTR_IN_VCT_CONTEXT
Flag (of type Boolean) indicating whether screen transformation is being performed inside VCT context |
static String |
ATTR_IN_WIDGET_PREVIEW
Flag (of type Boolean) indicating whether screen transformation is being performed for the purpose of a widget preview (probably within the Insert Host Component Wizard) (available as a context attribute) |
static String |
ATTR_IN_WIZARD
Flag (of type Boolean) indicating whether screen transformation is being performed inside one of the Studio wizards (available as a context attribute) |
static String |
ATTR_INCLUDE_EMPTY_PROTECTED_FIELDS
Flag (of type Boolean) indicating whether tags should be generated for empty, protected fields |
static String |
ATTR_IS_FREE_LAYOUT_MODE
Flag (of type Boolean) indicating whether the Page Designer editor is in "free layout" mode (application during Studio previewing only) |
static String |
ATTR_MOD_10
HTML input tag attribute name for a "mod 10" (5250 only) field |
static String |
ATTR_MOD_11
HTML input tag attribute name for a "mod 11" (5250 only) field |
static String |
ATTR_NUMERIC_SWAPPING
Internal constant related to numeric swapping (Bidi-only) |
static String |
ATTR_OUTPUT_TAGS_IN_DEFAULT_RENDERING
Flag (of type Boolean) indicating whether the default rendering engine should output tags instead of HTML |
static String |
ATTR_PAGE_CONTEXT
Servlet page context (available as a context attribute) |
static String |
ATTR_RENDERING_RULES_ENGINE
Reference to the RenderingRulesEngine object associated with the current screen transformation (available as a context attribute) |
static String |
ATTR_REQUEST
|
static String |
ATTR_RESPONSE
|
static String |
ATTR_RUNTIME_RTL
Internal constant related to right-to-left (Bidi-only) |
static String |
ATTR_SCREEN_ORIENTATION
Internal constant related to screen orientation (Bidi-only) |
static String |
ATTR_SCRIPT_LANGUAGE
Name of the scripting language to generate scripts in (see the individual com.ibm.hats.transform.actions.ScriptAction classes) (available as a context attribute) |
static String |
ATTR_SCRIPTING_DISABLED
Flag (of type Boolean) to indicate whether scripting (normally Javascript generation) is disabled (available as a context attribute) |
static String |
ATTR_SERVLET_CONTEXT
Servlet context (available as a context attribute) |
static String |
ATTR_SESSION
|
static String |
ATTR_SHARED_GLOBAL_VARIABLES
Shared global variables Hashtable (available as a context attribute) |
static String |
ATTR_STUDIO_PROJECT_PATH
String path (to the root of the Web Content folder) of the project (available as a context attribute) |
static String |
ATTR_STUDIO_TEMPORARY_PATH
Temporary folder (of type java.io.File) used during Studio development (available as a context attribute) |
static String |
ATTR_SYMMETRIC_SWAPPING
Internal constant related to symmetric swapping (Bidi-only) |
static String |
ATTR_TEXT_REPLACEMENTS
Text replacement list (available as a context attribute) |
static String |
ATTR_TRANSFORM_INFO
Transform information object (available as a context attribute) |
static String |
ATTR_USE_ACCENTED_CHARACTER
Internal constant related to use accented character (937 Macau support) |
static String |
ATTR_WIDGET_CLASS_NAME
Fully-qualified widget class name (available as a context attribute) |
static String |
COMMON_FOLDER
|
static String |
COMMON_IMAGE_FOLDER
|
static String |
COMMON_STYLESHEET_FOLDER
|
static String |
COMPONENT_TAG
Stub HATS:Component tag |
static String |
COMPONENT_WIDGET_PROPERTIES_CLASS
|
static String |
COMPONENTS_ALIGNMENT_LEFT
|
static String |
COMPONENTS_ALIGNMENT_RIGHT
|
static String |
CSS_SUFFIX
Suffix for each widget setting related to a CSS style class |
static String |
DEFAULT_RENDERING_TAG
Stub HATS:DefaultRendering tag |
static String |
DYNAMIC_COMPONENT_TAG
Stub HATS:Component tag (used in transformation fragments) |
static String |
FA_ATTREND
field attribute shorthand end of container |
static char |
FA_ATTRREV
field attribute shorthand for a NOT condition in the shorhand notation |
static String |
FA_ATTRSEPARATOR
field attribute shorthand separator |
static String |
FA_ATTRSTART
field attribute shorthand beginning of container |
static String |
FA_B
field attribute shorthand for blinking field character |
static String |
FA_BGC
field attribute shorthand for a background color of a field character, post-indicated by hex chararacter, for example b_7 |
static String |
FA_C
field attribute shorthand for a column separator field character |
static String |
FA_FGC
field attribute shorthand for a foreground color of a field character, post-indicated by hex chararacter, for example f_7 |
static String |
FA_H
field attribute shorthand for a hidden field character |
static String |
FA_HI
field attribute shorthand for high intensity field character |
static String |
FA_NO
field attribute shorthand for a numeric only field character |
static String |
FA_P
field attribute shorthand for a protected field character |
static String |
FA_RV
field attribute shorthand for a reversed video field character |
static String |
FA_UL
field attribute shorthand for underlined field character |
static String |
FORM_COMMAND
|
static String |
FORM_CURSORPOSITION
|
static String |
FORM_KEYBOARDTOGGLE
|
static String |
FORM_SESSIONNUMBER
|
static String |
ID_NAME_ID
|
static String |
ID_NAME_SEPARATOR
|
static String |
PROPERTY_COMPONENTS_ALIGNMENT
|
static String |
PROPERTY_STYLE
Style override widget setting name |
static String |
TRANSFORM_PACKAGE
Fully-qualified package name for the Transform package of classes |
| Constructor Summary | |
|---|---|
TransformationConstants()
|
|
| Method Summary |
|---|
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static final String ATTR_PAGE_CONTEXT
public static final String ATTR_SERVLET_CONTEXT
public static final String ATTR_HTTP_REQUEST
public static final String ATTR_GLOBAL_VARIABLES
public static final String ATTR_SHARED_GLOBAL_VARIABLES
public static final String ATTR_HTTP_RESPONSE
public static final String ATTR_TEXT_REPLACEMENTS
TextReplacementList,
Constant Field Valuespublic static final String ATTR_IN_STUDIO
public static final String ATTR_STUDIO_TEMPORARY_PATH
public static final String ATTR_STUDIO_PROJECT_PATH
public static final String ATTR_TRANSFORM_INFO
TransformInfo,
Constant Field Valuespublic static final String ATTR_COMPONENT_CLASS_NAME
public static final String ATTR_WIDGET_CLASS_NAME
public static final String ATTR_FORM_ID
public static final String ATTR_RENDERING_RULES_ENGINE
AbstractRenderingRulesEngine,
Constant Field Valuespublic static final String ATTR_APPLY_RENDERING_RULES
public static final String ATTR_SCRIPTING_DISABLED
public static final String ATTR_SCRIPT_LANGUAGE
ScriptAction,
Constant Field Valuespublic static final String ATTR_IN_DEFAULT_RENDERING
public static final String ATTR_IN_COMPACT_RENDERING
public static final String ATTR_IN_SCREEN_COMBINATION
public static final String ATTR_IN_GLOBAL_RULES
public static final String ATTR_CLASS_SETTINGS
public static final String ATTR_IN_WIDGET_PREVIEW
public static final String ATTR_IN_WIZARD
public static final String ATTR_IN_VCT_CONTEXT
public static final String ATTR_IN_COMPONENT_PREVIEW
public static final String ATTR_CLASS_LOADER
ClassLoader,
Constant Field Valuespublic static final String ATTR_OUTPUT_TAGS_IN_DEFAULT_RENDERING
public static final String ATTR_INCLUDE_EMPTY_PROTECTED_FIELDS
public static final String ATTR_IS_FREE_LAYOUT_MODE
public static final String ATTR_USE_ACCENTED_CHARACTER
public static final String ATTR_CODEPAGE
public static final String ATTR_SCREEN_ORIENTATION
public static final String ATTR_SYMMETRIC_SWAPPING
public static final String ATTR_NUMERIC_SWAPPING
public static final String ATTR_ARABIC_ORIENTATION
public static final String ATTR_RUNTIME_RTL
public static final String ATTR_DIRECTION_TEXT
public static final String ATTR_DIRECTION
public static final String ATTR_DIRECTION_WIDGET
public static final String PROPERTY_STYLE
public static final String CSS_SUFFIX
public static final String COMPONENT_TAG
public static final String DYNAMIC_COMPONENT_TAG
public static final String DEFAULT_RENDERING_TAG
public static final String TRANSFORM_PACKAGE
public static final String COMPONENT_WIDGET_PROPERTIES_CLASS
public static final String COMMON_FOLDER
public static final String COMMON_IMAGE_FOLDER
public static final String COMMON_STYLESHEET_FOLDER
public static final String ATTR_MOD_10
public static final String ATTR_MOD_11
public static final String ATTR_AUTO_ENTER
public static final String ATTR_FILL_REQUIRED
public static final String ATTR_ENTRY_REQUIRED
public static final String ATTR_FIELD_EXIT_REQUIRED
public static final String ATTR_DISABLE_AUTO_ADVANCE
public static final String FA_ATTRSTART
public static final String FA_ATTREND
public static final String FA_ATTRSEPARATOR
public static final char FA_ATTRREV
public static final String FA_P
public static final String FA_H
public static final String FA_NO
public static final String FA_HI
public static final String FA_BGC
public static final String FA_FGC
public static final String FA_RV
public static final String FA_UL
public static final String FA_B
public static final String FA_C
public static final String FORM_COMMAND
public static final String FORM_CURSORPOSITION
public static final String FORM_KEYBOARDTOGGLE
public static final String FORM_SESSIONNUMBER
public static final String ID_NAME_SEPARATOR
public static final String ID_NAME_ID
public static final String ATTR_REQUEST
public static final String ATTR_RESPONSE
public static final String ATTR_SESSION
public static final String ATTR_CONTEXT
public static final String PROPERTY_COMPONENTS_ALIGNMENT
public static final String COMPONENTS_ALIGNMENT_LEFT
public static final String COMPONENTS_ALIGNMENT_RIGHT
| Constructor Detail |
|---|
public TransformationConstants()
|
HATS 7.5.1 (201005110649) | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||