UserConfig (Agentflow)

java.lang.Object
- pe.pase.UserConfig

All Implemented Interfaces:

java.io.Serializable
```
public class UserConfig
extends java.lang.Object
implements java.io.Serializable
```
The class holds the information of user config.

Version:

1.1.5,

Author:

Mars

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

UserConfig()
Constructor.

Constructors
Constructor and Description
`UserConfig()` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`getAdjustPage()`
`boolean`	`getAutoLogout()` Get the auto-logout.
`boolean`	`getLogoutArtSave()` Get the setting of "logout artifact save"
`MonitorFilterCondition`	`getMFC()` Get the monitor filter condition
`boolean`	`getNewPASEMessageNotify()` Get the setting of "new PASEMessage notify"
`boolean`	`getNewTaskNotify()` Get the setting of "new task notify"
`java.lang.String`	`getPageFormatStr()` Get the page format string.
`java.lang.String`	`getPageSizeName()` Get the page size name for printing.
`boolean`	`getPrintBarCode()`
`boolean`	`getPrintFooter()` Get print footer.
`java.lang.String`	`getPrintMode()` Get print mode
`java.lang.String`	`getPrintPage()` Get the print page
`boolean`	`getTFSearchDir()` Get the search direction of task frame
`int`	`getTFSearchFld()` Get the search field of task frame
`java.lang.String`	`getTFSearchKey()` Get the search keyword of task frame
`int`	`getTimeOut()` Get time out value
`boolean`	`getUnreadPASEMessageNotify()` Get the setting of "unread PASEMessage notify"
`java.lang.String`	`getWebSkinName()` Get skinname config(for WebAgenda)
`java.lang.String`	`getWithSignRecords()`
`boolean`	`isBtnCmpHidden()` Is button component on the `Form` beging hidden while printing the `Form`.
`boolean`	`isPdfTextAntialiasOff()`
`java.lang.String`	`packConfig()` Pack the config into a config string.
`void`	`parseConfig(java.lang.String config)` Parse the config string and set these config.
`void`	`setAdjustPage(boolean bAdj)`
`void`	`setAutoLogout(boolean autoLogout)` Set the auto-logout.
`void`	`setBtnCmpHidden(boolean aHideBtnCmp)` Set the button component on the `Form` beging hidden or not while printing the `Form`.
`void`	`setLogoutArtSave(boolean logoutArtSave)` Set the setting of "logout artifact save" true the artifact will save when the user logout; false otherwise
`void`	`setMFC(MonitorFilterCondition mfc)` Set the monitor filter condition
`void`	`setNewPASEMessageNotify(boolean b)` Set the setting of "new PASEMessage notify" true the system will notify user when new PASEMessage has come; false otherwise
`void`	`setNewTaskNotify(boolean b)` Set the setting of "new task notify" true the system will notify user when new task has come; false otherwise
`void`	`setPageFormatStr(java.lang.String formatStr)` Set the page format string.
`void`	`setPageSizeName(java.lang.String aPageSizeName)` Set the page size name for printing.
`void`	`setPdfTextAntialiasOff(boolean pdfTextAntialiasOff)`
`void`	`setPrintBarCode(boolean bBarCode)`
`void`	`setPrintFooter(boolean bFooter)` Set print footer.
`void`	`setPrintMode(java.lang.String pm)` Set print mode
`void`	`setPrintPage(java.lang.String pm)` Set the print page
`void`	`setTFSearchDir(boolean sd)` Set the search direction of task frame
`void`	`setTFSearchFld(int sf)` Set the search field of task frame
`void`	`setTFSearchKey(java.lang.String sk)` Set the search keyword of task frame
`void`	`setTimeOut(int timeOut)` Set time out value
`void`	`setUnreadPASEMessageNotify(boolean b)` Set the setting of "unread PASEMessage notify" true the system will notify user when unread PASEMessage has come; false otherwise
`void`	`setWebSkinName(java.lang.String skname)` Set skinname config(for WebAgenda)
`void`	`setWithSignRecords(java.lang.String withSignRecords)`
`java.lang.String`	`toString()` Returns a string representation of the instance of `UserConfig` object
`void`	`update(UserConfig newConfig)` Update the data of `UserConfig` instance.

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

- Constructor Detail
  - UserConfig
```
public UserConfig()
```
    Constructor. Construct a instance of UserConfig without parameters.
    
    Since:
    
    version 1.0.0
- Method Detail
  - getTFSearchKey
```
public java.lang.String getTFSearchKey()
```
    Get the search keyword of task frame
    
    Returns:
    
    the search keyword of task frame
    
    Since:
    
    version 1.0.0
  - setTFSearchKey
```
public void setTFSearchKey(java.lang.String sk)
```
    Set the search keyword of task frame
    
    Parameters:
    
    sk - the given search keyword
    
    Since:
    
    version 1.0.0
  - getTFSearchFld
```
public int getTFSearchFld()
```
    Get the search field of task frame
    
    Returns:
    
    the search field
    
    Since:
    
    version 1.0.0
  - setTFSearchFld
```
public void setTFSearchFld(int sf)
```
    Set the search field of task frame
    
    Parameters:
    
    sf - the given search field of task frame
    
    Since:
    
    version 1.0.0
  - getTFSearchDir
```
public boolean getTFSearchDir()
```
    Get the search direction of task frame
    
    Returns:
    
    true the direction is from top to bottom; false otherwise
    
    Since:
    
    version 1.0.0
  - setTFSearchDir
```
public void setTFSearchDir(boolean sd)
```
    Set the search direction of task frame
    
    Parameters:
    
    sd - the given boolean value
    
    Since:
    
    version 1.0.0
  - getMFC
```
public MonitorFilterCondition getMFC()
```
    Get the monitor filter condition
    
    Returns:
    
    the monitor filter condition
    
    Since:
    
    verion 1.0.0
    
    See Also:
    
    MonitorFilterCondition
  - setMFC
```
public void setMFC(MonitorFilterCondition mfc)
```
    Set the monitor filter condition
    
    Parameters:
    
    mfc - the given monitor filter condition
    
    Since:
    
    version 1.0.0
    
    See Also:
    
    MonitorFilterCondition
  - getPrintMode
```
public java.lang.String getPrintMode()
```
    Get print mode
    
    Returns:
    
    the print mode (PrintingConstants.JAVA_MODE, PrintConstants.PDF_MODE, PrintConstants.JPG_FILE_MODE, PrintConstants.PDF_FILE_MODE)
    
    Since:
    
    version 1.0.0
    
    See Also:
    
    PrintingConstants
  - setPrintMode
```
public void setPrintMode(java.lang.String pm)
```
    Set print mode
    
    Parameters:
    
    pm - the given print mode
    
    Since:
    
    version 1.0.0
  - getPrintPage
```
public java.lang.String getPrintPage()
```
    Get the print page
    
    Returns:
    
    the print page (PrintConstants.FULL_PAGE, PrintConstants.CUT_PAGE, PrintConstants.ORIGINAL_PAGE, PrintConstants.SHRINK_PAGE)
    
    Since:
    
    version 1.0.0
    
    See Also:
    
    PrintingConstants
  - setPrintPage
```
public void setPrintPage(java.lang.String pm)
```
    Set the print page
    
    Parameters:
    
    pm - the given print page
    
    Since:
    
    version 1.0.0
  - getPrintFooter
```
public boolean getPrintFooter()
```
    Get print footer. The print footer is the page number.
    
    Returns:
    
    true the footer is shown; false otherwise
    
    Since:
    
    version 1.0.0
  - setPrintFooter
```
public void setPrintFooter(boolean bFooter)
```
    Set print footer. The print footer is the page numbwe.
    
    Parameters:
    
    bFooter - the given boolean value
    
    Since:
    
    version 1.0.0
  - setPrintBarCode
```
public void setPrintBarCode(boolean bBarCode)
```
  - getPrintBarCode
```
public boolean getPrintBarCode()
```
  - getAdjustPage
```
public boolean getAdjustPage()
```
  - setAdjustPage
```
public void setAdjustPage(boolean bAdj)
```
  - getPageFormatStr
```
public java.lang.String getPageFormatStr()
```
    Get the page format string. The string format is " Width,Height,ImageableX,ImageableY,ImageableWidth,ImageableHeight,Orientation".
    
    Returns:
    
    the page format string
    
    Since:
    
    version 1.0.0
  - setPageFormatStr
```
public void setPageFormatStr(java.lang.String formatStr)
```
    Set the page format string.
    
    Parameters:
    
    formatStr - the given string
    
    Since:
    
    version 1.0.0
  - getPageSizeName
```
public java.lang.String getPageSizeName()
```
    Get the page size name for printing.
    
    Returns:
    
    page size name such as A4, A3, etc.
    
    Since:
    
    2.2.2.3
  - setPageSizeName
```
public void setPageSizeName(java.lang.String aPageSizeName)
```
    Set the page size name for printing.
    
    Parameters:
    
    aPageSizeName -
    
    Since:
    
    2.2.2.3
  - isBtnCmpHidden
```
public boolean isBtnCmpHidden()
```
    Is button component on the Form beging hidden while printing the Form.
    
    Returns:
    
    true if buttons should be hidden, else false;
    
    Since:
    
    2.2.2.3
  - setBtnCmpHidden
```
public void setBtnCmpHidden(boolean aHideBtnCmp)
```
    Set the button component on the Form beging hidden or not while printing the Form.
    
    Parameters:
    
    aHideBtnCmp -
    
    Since:
    
    2.2.2.3
  - getAutoLogout
```
public boolean getAutoLogout()
```
    Get the auto-logout.
    
    Returns:
    
    true the system will auto-logout; false otherwise
    
    Since:
    
    version 1.0.0
  - setAutoLogout
```
public void setAutoLogout(boolean autoLogout)
```
    Set the auto-logout. true the system will auto-logout; false otherwise
    
    Parameters:
    
    autoLogout - the given boolean value
    
    Since:
    
    version 1.0.0
  - getLogoutArtSave
```
public boolean getLogoutArtSave()
```
    Get the setting of "logout artifact save"
    
    Returns:
    
    true the artifact will save when the user logout; false otherwise
    
    Since:
    
    version 1.0.0
  - setLogoutArtSave
```
public void setLogoutArtSave(boolean logoutArtSave)
```
    Set the setting of "logout artifact save" true the artifact will save when the user logout; false otherwise
    
    Parameters:
    
    logoutArtSave - the given boolean value
    
    Since:
    
    version 1.0.0
  - getTimeOut
```
public int getTimeOut()
```
    Get time out value
    
    Returns:
    
    the value
    
    Since:
    
    version 1.0.0
  - setTimeOut
```
public void setTimeOut(int timeOut)
```
    Set time out value
    
    Parameters:
    
    timeOut - the given value
    
    Since:
    
    version 1.0.0
  - setNewTaskNotify
```
public void setNewTaskNotify(boolean b)
```
    Set the setting of "new task notify" true the system will notify user when new task has come; false otherwise
    
    Parameters:
    
    b - the given boolean value
    
    Since:
    
    version 1.0.0
  - getNewTaskNotify
```
public boolean getNewTaskNotify()
```
    Get the setting of "new task notify"
    
    Returns:
    
    true the system will notify user when new task has come; false otherwise
    
    Since:
    
    version 1.0.0
  - setWebSkinName
```
public void setWebSkinName(java.lang.String skname)
```
    Set skinname config(for WebAgenda)
    
    Parameters:
    
    skname - the skinname
  - getWebSkinName
```
public java.lang.String getWebSkinName()
```
    Get skinname config(for WebAgenda)
    
    Returns:
    
    the skinname config of user
  - setNewPASEMessageNotify
```
public void setNewPASEMessageNotify(boolean b)
```
    Set the setting of "new PASEMessage notify" true the system will notify user when new PASEMessage has come; false otherwise
    
    Parameters:
    
    b - the given boolean value
    
    Since:
    
    version 1.0.0
  - getNewPASEMessageNotify
```
public boolean getNewPASEMessageNotify()
```
    Get the setting of "new PASEMessage notify"
    
    Returns:
    
    true the system will notify user when new PASEMessage has come; false otherwise
    
    Since:
    
    version 1.0.0
  - setUnreadPASEMessageNotify
```
public void setUnreadPASEMessageNotify(boolean b)
```
    Set the setting of "unread PASEMessage notify" true the system will notify user when unread PASEMessage has come; false otherwise
    
    Parameters:
    
    b - the given boolean value
    
    Since:
    
    version 1.0.0
  - getUnreadPASEMessageNotify
```
public boolean getUnreadPASEMessageNotify()
```
    Get the setting of "unread PASEMessage notify"
    
    Returns:
    
    true the system will notify user when unread PASEMessage has come; false otherwise
    
    Since:
    
    version 1.0.0
  - isPdfTextAntialiasOff
```
public boolean isPdfTextAntialiasOff()
```
  - setPdfTextAntialiasOff
```
public void setPdfTextAntialiasOff(boolean pdfTextAntialiasOff)
```
  - getWithSignRecords
```
public java.lang.String getWithSignRecords()
```
  - setWithSignRecords
```
public void setWithSignRecords(java.lang.String withSignRecords)
```
  - parseConfig
```
public void parseConfig(java.lang.String config)
```
    Parse the config string and set these config. The config string format is "[TFSK=value][TFSF=value][TFSD=value][MFC=2,op,type,field,value1,value2,op,type...]"
    
    Parameters:
    
    config - the given config string
    
    Since:
    
    version 1.0.0
  - packConfig
```
public java.lang.String packConfig()
```
    Pack the config into a config string. The string format is "[TFSK=value][TFSF=value][TFSD=value] [MFC=2,op,type,field,value1,value2,op,type...]" ex: [TFSK=][TFSF=0][TFSD=false][MFC=][PrintMode=null] [PrintPage=null][PrintFooter=false][AdjustPage=false] [PageFormat=595,841,42,14,496,756,1][AutoLogout=false] [NewTaskNotify=false][NewPASEMessageNotify=false] [UnreadPASEMessageNotify=false][LogoutArtSave=false] [TimeOut=0][WebSkinName=default]
    
    Returns:
    
    the string
    
    Since:
    
    version 1.0.0
  - update
```
public void update(UserConfig newConfig)
```
    Update the data of UserConfig instance.
    
    Parameters:
    
    newConfig - the given UserConfig instance
    
    Since:
    
    version 1.0.0
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of the instance of UserConfig object
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    "m_printMode=[print mode],m_printPage=[print page],m_printFooter=[print footer],m_pageForamtStr=[page format string],m_autoLogout=[auto-logout],m_newTaskNotify=[new task notify],m_logoutArtSave=[logout artifact save],m_TimeOut=[timeout]"
    
    Since:
    
    version 1.0.0

Class UserConfig

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

UserConfig

Method Detail

getTFSearchKey

setTFSearchKey

getTFSearchFld

setTFSearchFld

getTFSearchDir

setTFSearchDir

getMFC

setMFC

getPrintMode

setPrintMode

getPrintPage

setPrintPage

getPrintFooter

setPrintFooter

setPrintBarCode

getPrintBarCode

getAdjustPage

setAdjustPage

getPageFormatStr

setPageFormatStr

getPageSizeName

setPageSizeName

isBtnCmpHidden

setBtnCmpHidden

getAutoLogout

setAutoLogout

getLogoutArtSave

setLogoutArtSave

getTimeOut

setTimeOut

setNewTaskNotify

getNewTaskNotify

setWebSkinName

getWebSkinName

setNewPASEMessageNotify

getNewPASEMessageNotify

setUnreadPASEMessageNotify

getUnreadPASEMessageNotify

isPdfTextAntialiasOff

setPdfTextAntialiasOff

getWithSignRecords

setWithSignRecords

parseConfig

packConfig

update

toString