GXRenderConfig (ApplinX API Specification)

java.lang.Object
- com.sabratec.applinx.presentation.GXRenderConfig

All Implemented Interfaces:

Serializable
```
public class GXRenderConfig
extends Object
implements Serializable
```
This class is used for setting the Renderer configuration. It contains various configurations such as screen area, font size and sub classes for various built-in transformation configurations such as:
Host keys, GUI elements, Tables, Windows, etc.
Each configuration sub class allows disabling a specific built-in transformation.
This class also provides transformations registration of tag listener GXTagListener
and completion listener
GXICompletionListener.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

GXRenderConfig()

Constructors
Constructor and Description
`GXRenderConfig()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addCompletionListener(GXICompletionListener listener)` Used for registering a listener class that can modify the screen tag model.
`void`	`addTagListener(GXITagListener listener)` Used for registering a listener class which accepts an event for each tag type.
`Vector`	`get_CompleteListenersVector()` For .NET framework usage.
`boolean`	`get_Dynamic()` For .NET framework usage.
`GXEmulationTransformConfig`	`get_EmulationConfig()` For .NET framework usage.
`String`	`get_FontFamily()` For .NET framework usage.
`int`	`get_FontSize()` For .NET framework usage.
`GXGuiElementsTransformConfig`	`get_GuiElementsConfig()` For .NET framework usage.
`GXHostKeysTransformConfig`	`get_HostKeysConfig()` For .NET framework usage.
`boolean`	`get_PaintAllColumnHeight()` For .NET framework usage.
`GXRectangle`	`get_Rectangle()` For .NET framework usage.
`GXRectangle`	`get_RenderArea()` For .NET framework usage.
`boolean`	`get_RenderTagsFromRightToLeft()` For .NET framework usage.
`int`	`get_RowSpacingPrecentageFactor()` For .NET framework usage.
`GXTableTransformConfig`	`get_TableConfig()` For .NET framework usage.
`GXWindowFrameTransformConfig`	`get_WindowFrameConfig()` For .NET framework usage.
`GXICompletionListener[]`	`getCompletionListener()` Used for retrieving all the registered completion listeners.
`GXEmulationTransformConfig`	`getEmulationConfig()` The emulation transformation configuration contains properties which determine the rendered tag look-and-feel and behavior.
`String`	`getFontFamily()` Sets the font family to be used for instant rendering.
`int`	`getFontSize()` Used for retrieving the font size.
`double`	`getFontWidth()`
`GXGuiElementsTransformConfig`	`getGuiElementsConfig()` The GUI elements transformation configuration.
`GXHostKeysTransformConfig`	`getHostKeysConfig()` The Host keys transformation configuration.
`double`	`getInputBorderWidth()`
`double`	`getInputFieldHeight()`
`boolean`	`getIsDynamicFont()`
`boolean`	`getPaintAllColumnHeight()` Returns the value that determines if the full height of the column should be background colored in reversed video or just the font size height.
`GXRectangle`	`getRenderArea()` The rendered area of the host screen which the tags are rendered from.
`int`	`getRowSpacingPrecentageFactor()` Returns the row height to be used for instant rendering.
`GXTableTransformConfig`	`getTableConfig()` The table transformation configuration.
`GXITagListener[]`	`getTagListeners()` Used for retrieving all the registered tag listeners.
`GXWindowFrameTransformConfig`	`getWindowFrameConfig()` The window transformation configuration.
`boolean`	`isRenderTagsFromRightToLeft()` Determines that the HTML tags will be positioned from right to left.
`void`	`removeAllListeners()`
`void`	`set_Dynamic(boolean isDynamic)` For .NET framework usage.
`void`	`set_EmulationConfig(GXEmulationTransformConfig emulationConfig)` For .NET framework usage.
`void`	`set_FontFamily(String fontFamily)` For .NET framework usage.
`void`	`set_FontSize(int fontSize)` For .NET framework usage.
`void`	`set_GuiElementsConfig(GXGuiElementsTransformConfig guiElementsConfig)` For .NET framework usage.
`void`	`set_HostKeysConfig(GXHostKeysTransformConfig hostKeysConfig)` For .NET framework usage.
`void`	`set_PaintAllColumnHeight(boolean isPaintAllColumnHeight)` For .NET framework usage.
`void`	`set_Rectangle(GXRectangle rectangle)` For .NET framework usage.
`void`	`set_RenderArea(GXRectangle rectangle)` For .NET framework usage.
`void`	`set_RenderTagsFromRightToLeft(boolean renderTagsFromRightToLeft)` For .NET framework usage.
`void`	`set_RowSpacingPrecentageFactor(int rowSpacingPrecentageFactor)` For .NET framework usage.
`void`	`set_TableConfig(GXTableTransformConfig tableConfig)` For .NET framework usage.
`void`	`set_WindowFrameConfig(GXWindowFrameTransformConfig windowConfig)` For .NET framework usage.
`void`	`setEmulationConfig(GXEmulationTransformConfig emulationConfig)`
`void`	`setFontFamily(String fontFamily)` Sets the font family to be used for instant rendering.
`void`	`setFontSize(int fontSize)` It is possible to change the default font size to a different size (in pixels).
`void`	`setFontWidth(double m_fontWidth)`
`void`	`setGuiElementsConfig(GXGuiElementsTransformConfig guiElementsConfig)`
`void`	`setHostKeysConfig(GXHostKeysTransformConfig hostKeysConfig)`
`void`	`setInputBorderWidth(double inputBorderWidth)`
`void`	`setInputFieldHeight(double inputFieldHeight)`
`void`	`setIsDynamicFont(boolean isDynamic)`
`void`	`setPaintAllColumnHeight(boolean isPaintAllColumnHeight)` The row height is the font size plus the font size multiplied in the value of the rowSpacing variable.
`void`	`setRenderArea(GXRectangle rectangle)` Used to define that a specific area of the host screen will be rendered as HTML in Instant HTML pages by specifying the area's boundaries and in this way hide certain portions of the screen. By default, the entire screen is configured to be rendered to the HTML output.
`void`	`setRenderTagsFromRightToLeft(boolean renderTagsFromRightToLeft)` Determines that the HTML tags will be positioned from right to left.
`void`	`setRowSpacingPrecentageFactor(int rowSpacingPrecentageFactor)` Sets the row height to be used for instant rendering.
`void`	`setTableConfig(GXTableTransformConfig tableConfig)`
`void`	`setWindowFrameConfig(GXWindowFrameTransformConfig windowFrameConfig)`

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

- Constructor Detail
  - GXRenderConfig
```
public GXRenderConfig()
```
- Method Detail
  - addTagListener
```
public void addTagListener(GXITagListener listener)
```
    Used for registering a listener class which accepts an event for each tag type.
    
    Parameters:
    
    listener - The tag listener
  - addCompletionListener
```
public void addCompletionListener(GXICompletionListener listener)
```
    Used for registering a listener class that can modify the screen tag model.
    
    Parameters:
    
    listener - The completion listener
  - setRenderArea
```
public void setRenderArea(GXRectangle rectangle)
```
    Used to define that a specific area of the host screen will be rendered as HTML in Instant HTML pages by specifying the area's boundaries and in this way hide certain portions of the screen.
    By default, the entire screen is configured to be rendered to the HTML output.
    When setting the area to be rendered, tags positioned outside the rendered area will not be available for query execution on the screen tag model. The rendered area also affects the rendered top/left attributes of the tag. The top/left tag will be calculated relatively to the starting position of the rendered area.
    
    Parameters:
    
    rectangle - The positions of the rendered area
  - set_RenderArea
```
public void set_RenderArea(GXRectangle rectangle)
```
    For .NET framework usage. Expose the method as a property.
    
    See Also:
    
    setRenderArea(GXRectangle)
  - getRenderArea
```
public GXRectangle getRenderArea()
```
    The rendered area of the host screen which the tags are rendered from.
    
    Returns:
    
    A rectangle that represent the render area
    
    See Also:
    
    setRenderArea(GXRectangle)
  - get_Rectangle
```
public GXRectangle get_Rectangle()
```
    For .NET framework usage. Expose the method as a property.
  - set_Rectangle
```
public void set_Rectangle(GXRectangle rectangle)
```
    For .NET framework usage. Expose the method as a property.
  - get_RenderArea
```
public GXRectangle get_RenderArea()
```
    For .NET framework usage. Expose the method as a property.
    
    See Also:
    
    getRenderArea()
  - getFontSize
```
public int getFontSize()
```
    Used for retrieving the font size.
    
    Returns:
    
    The font size
    
    See Also:
    
    setFontSize(int)
  - get_FontSize
```
public int get_FontSize()
```
    For .NET framework usage. Expose the method as a property.
    
    See Also:
    
    getFontSize()
  - setFontSize
```
public void setFontSize(int fontSize)
```
    It is possible to change the default font size to a different size (in pixels). Since the change affects the rendering process performed by the framework on the Web server, this setting is not part of the CSS style sheet file (unlike other font settings), but instead it is included in the server-side instant configuration parameters.
    Note: Changing the font sizes for generated Web pages is done in the CSS style sheet node.
    The possible values include the different pixel possibilities as well as "Dynamic by Resolution". The HTML emulation recognizes user resolution and dynamically changes the css name according to the matching resolution. The resolution can be either 640x480, 800x600, 1024x768 or 1280x1024 pixels. The resolution may also depend on the host resolution (80 or 132 characters). The best-fit functionality is configured by default in the emulation template in all frameworks. It is used by the renderer to calculate the top/left according to each tag's position.
    
    Parameters:
    
    fontSize - The font size to set.
  - set_FontSize
```
public void set_FontSize(int fontSize)
```
    For .NET framework usage. Expose the method as a property.
    
    See Also:
    
    setFontSize(int)
  - getEmulationConfig
```
public GXEmulationTransformConfig getEmulationConfig()
```
    The emulation transformation configuration contains properties which determine the rendered tag look-and-feel and behavior.
    
    Returns:
    
    The emulation transformation configuration.
  - setEmulationConfig
```
public void setEmulationConfig(GXEmulationTransformConfig emulationConfig)
```
  - get_EmulationConfig
```
public GXEmulationTransformConfig get_EmulationConfig()
```
    For .NET framework usage. Expose the method as a property.
    
    See Also:
    
    getEmulationConfig()
  - set_EmulationConfig
```
public void set_EmulationConfig(GXEmulationTransformConfig emulationConfig)
```
    For .NET framework usage. Expose the method as a property.
  - getGuiElementsConfig
```
public GXGuiElementsTransformConfig getGuiElementsConfig()
```
    The GUI elements transformation configuration. The GUI elements transformation represents GUI elements which were configured using the ApplinX composer.
    
    Returns:
    
    The GUI elements' transformation configuration.
  - setGuiElementsConfig
```
public void setGuiElementsConfig(GXGuiElementsTransformConfig guiElementsConfig)
```
  - get_GuiElementsConfig
```
public GXGuiElementsTransformConfig get_GuiElementsConfig()
```
    For .NET framework usage. Expose the method as a property.
    
    See Also:
    
    getGuiElementsConfig()
  - getHostKeysConfig
```
public GXHostKeysTransformConfig getHostKeysConfig()
```
    The Host keys transformation configuration. Host keys transformation represents host keys patterns which were configured using the ApplinX composer.
    
    Returns:
    
    The host keys transformation configuration
  - setHostKeysConfig
```
public void setHostKeysConfig(GXHostKeysTransformConfig hostKeysConfig)
```
  - get_HostKeysConfig
```
public GXHostKeysTransformConfig get_HostKeysConfig()
```
    For .NET framework usage. Expose the method as a property.
    
    See Also:
    
    getHostKeysConfig()
  - set_HostKeysConfig
```
public void set_HostKeysConfig(GXHostKeysTransformConfig hostKeysConfig)
```
    For .NET framework usage. Expose the method as a property.
  - getTableConfig
```
public GXTableTransformConfig getTableConfig()
```
    The table transformation configuration. The table transformation is based on a host table that was configured using the ApplinX composer.
    
    Returns:
    
    The table configuration
  - setTableConfig
```
public void setTableConfig(GXTableTransformConfig tableConfig)
```
  - get_TableConfig
```
public GXTableTransformConfig get_TableConfig()
```
    For .NET framework usage. Expose the method as a property.
    
    See Also:
    
    getTableConfig()
  - set_TableConfig
```
public void set_TableConfig(GXTableTransformConfig tableConfig)
```
    For .NET framework usage. Expose the method as a property.
  - getWindowFrameConfig
```
public GXWindowFrameTransformConfig getWindowFrameConfig()
```
    The window transformation configuration. Window frame transformation draws a rectangle instead of drawing a host window which is represented as characters or reversed video.
    
    Returns:
    
    The window frame configuration
  - setWindowFrameConfig
```
public void setWindowFrameConfig(GXWindowFrameTransformConfig windowFrameConfig)
```
  - get_WindowFrameConfig
```
public GXWindowFrameTransformConfig get_WindowFrameConfig()
```
    For .NET framework usage. Expose the method as a property.
    
    See Also:
    
    getWindowFrameConfig()
  - set_WindowFrameConfig
```
public void set_WindowFrameConfig(GXWindowFrameTransformConfig windowConfig)
```
    For .NET framework usage. Expose the method as a property.
  - getTagListeners
```
public GXITagListener[] getTagListeners()
```
    Used for retrieving all the registered tag listeners.
    
    Returns:
    
    An array of the registered tag listeners
  - getCompletionListener
```
public GXICompletionListener[] getCompletionListener()
```
    Used for retrieving all the registered completion listeners.
    
    Returns:
    
    An array of the completion listeners
  - removeAllListeners
```
public void removeAllListeners()
```
  - getFontFamily
```
public String getFontFamily()
```
    Sets the font family to be used for instant rendering.
    
    Returns:
    
    the font family in use. null if no specific font to use(defined in the CSS file).
  - setFontFamily
```
public void setFontFamily(String fontFamily)
```
    Sets the font family to be used for instant rendering. It is used for proportion calculation to best fit specific fonts for Japanese & Arabic applications.
    For Japanese the best fitted fixed fonts are: "MS Mincho" or "MS Gothic"
    For Arabic the best fitted fixed font is: "Courier".
    For other languages the best fitted font is "Courier New", which is by default declared in the CSS files. Defining the font here will override the CSS definition.
    
    Parameters:
    
    fontFamily - the font family in use. null if no specific font to use(defined in the CSS file).
  - get_FontFamily
```
public String get_FontFamily()
```
    For .NET framework usage. Expose the method as a property.
  - set_FontFamily
```
public void set_FontFamily(String fontFamily)
```
    For .NET framework usage. Expose the method as a property.
  - getRowSpacingPrecentageFactor
```
public int getRowSpacingPrecentageFactor()
```
    Returns the row height to be used for instant rendering. This height is calculated relatively to the row�s font size. The default row height is set to 53% (153% of the font size). For example: When the font size is set to 13px, and using the default row height value of 53%, the row height will be:13*1.53 =19.89= ~20px.
    
    Returns:
    
    the row height to be used
  - setRowSpacingPrecentageFactor
```
public void setRowSpacingPrecentageFactor(int rowSpacingPrecentageFactor)
```
    Sets the row height to be used for instant rendering. This height is calculated relatively to the row�s font size. The default row height is set to 53% (153% of the font size). For example: When the font size is set to 13px, and using the default row height value of 53%, the row height will be:13*1.53 =19.89= ~20px.
    
    Parameters:
    
    rowHeightPrecentageFactor - the row height to be used
  - get_RowSpacingPrecentageFactor
```
public int get_RowSpacingPrecentageFactor()
```
    For .NET framework usage. Expose the method as a property.
  - set_RowSpacingPrecentageFactor
```
public void set_RowSpacingPrecentageFactor(int rowSpacingPrecentageFactor)
```
    For .NET framework usage. Expose the method as a property.
  - getPaintAllColumnHeight
```
public boolean getPaintAllColumnHeight()
```
    Returns the value that determines if the full height of the column should be background colored in reversed video or just the font size height.
    
    Returns:
    
    should the full height will be painted or just the font size height.
  - setPaintAllColumnHeight
```
public void setPaintAllColumnHeight(boolean isPaintAllColumnHeight)
```
    The row height is the font size plus the font size multiplied in the value of the rowSpacing variable. This property determines if the full height of the column should be background colored in reversed video or just the font size height.
  - get_PaintAllColumnHeight
```
public boolean get_PaintAllColumnHeight()
```
    For .NET framework usage. Expose the method as a property.
  - set_PaintAllColumnHeight
```
public void set_PaintAllColumnHeight(boolean isPaintAllColumnHeight)
```
    For .NET framework usage. Expose the method as a property.
  - isRenderTagsFromRightToLeft
```
public boolean isRenderTagsFromRightToLeft()
```
    Determines that the HTML tags will be positioned from right to left. The usage is in Hebrew/Arabic applications when using non-fixed font, to ensure alignment to the right. By default the tags are positioned from left to right.
    
    Returns:
  - setRenderTagsFromRightToLeft
```
public void setRenderTagsFromRightToLeft(boolean renderTagsFromRightToLeft)
```
    Determines that the HTML tags will be positioned from right to left. The usage is in Hebrew/Arabic applications when using non-fixed font, to ensure alignment to the right. By default the tags are positioned from left to right.
    
    Parameters:
    
    renderTagsFromRightToLeft -
  - get_RenderTagsFromRightToLeft
```
public boolean get_RenderTagsFromRightToLeft()
```
    For .NET framework usage. Expose the method as a property.
  - set_RenderTagsFromRightToLeft
```
public void set_RenderTagsFromRightToLeft(boolean renderTagsFromRightToLeft)
```
    For .NET framework usage. Expose the method as a property.
  - set_GuiElementsConfig
```
public void set_GuiElementsConfig(GXGuiElementsTransformConfig guiElementsConfig)
```
    For .NET framework usage. Expose the method as a property.
  - get_CompleteListenersVector
```
public Vector get_CompleteListenersVector()
```
    For .NET framework usage. Expose the method as a property.
  - getFontWidth
```
public double getFontWidth()
```
  - setFontWidth
```
public void setFontWidth(double m_fontWidth)
```
  - setInputFieldHeight
```
public void setInputFieldHeight(double inputFieldHeight)
```
  - getInputFieldHeight
```
public double getInputFieldHeight()
```
  - getInputBorderWidth
```
public double getInputBorderWidth()
```
  - setInputBorderWidth
```
public void setInputBorderWidth(double inputBorderWidth)
```
  - getIsDynamicFont
```
public boolean getIsDynamicFont()
```
  - setIsDynamicFont
```
public void setIsDynamicFont(boolean isDynamic)
```
  - get_Dynamic
```
public boolean get_Dynamic()
```
    For .NET framework usage. Expose the method as a property.
  - set_Dynamic
```
public void set_Dynamic(boolean isDynamic)
```
    For .NET framework usage. Expose the method as a property.

Class GXRenderConfig

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GXRenderConfig

Method Detail

addTagListener

addCompletionListener

setRenderArea

set_RenderArea

getRenderArea

get_Rectangle

set_Rectangle

get_RenderArea

getFontSize

get_FontSize

setFontSize

set_FontSize

getEmulationConfig

setEmulationConfig

get_EmulationConfig

set_EmulationConfig

getGuiElementsConfig

setGuiElementsConfig

get_GuiElementsConfig

getHostKeysConfig

setHostKeysConfig

get_HostKeysConfig

set_HostKeysConfig

getTableConfig

setTableConfig

get_TableConfig

set_TableConfig

getWindowFrameConfig

setWindowFrameConfig

get_WindowFrameConfig

set_WindowFrameConfig

getTagListeners

getCompletionListener

removeAllListeners

getFontFamily

setFontFamily

get_FontFamily

set_FontFamily

getRowSpacingPrecentageFactor

setRowSpacingPrecentageFactor

get_RowSpacingPrecentageFactor

set_RowSpacingPrecentageFactor

getPaintAllColumnHeight

setPaintAllColumnHeight

get_PaintAllColumnHeight

set_PaintAllColumnHeight

isRenderTagsFromRightToLeft

setRenderTagsFromRightToLeft

get_RenderTagsFromRightToLeft

set_RenderTagsFromRightToLeft

set_GuiElementsConfig

get_CompleteListenersVector

getFontWidth

setFontWidth

setInputFieldHeight

getInputFieldHeight

getInputBorderWidth

setInputBorderWidth

getIsDynamicFont

setIsDynamicFont

get_Dynamic

set_Dynamic