|
XMOJO 5 API Docs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.adventnet.adaptors.html.HtmlPageProp
This class helps to generate run time or dynamic html pages for the instrumented MBeans. This class having certain methods like createDynamicIndexFile(), createHtmlPage(), etc, the user should invoke these methods from the servlet.
Even most of the html pages created in the run time, HtmlPageProp class allows certain levels of customization like author, header, title, description, footer message, logo, background colour, etc. All these attributes have default values, if you don't want those settings the user can set his own values.
Field Summary | |
java.lang.String |
alinkColor
|
java.lang.String |
author
|
java.lang.String |
backGroundColor
|
java.lang.String |
backGroundImage
|
int |
backTagLocation
|
int |
BOTTOM_CENTER
The home page link will be at bottom center. |
int |
BOTTOM_LEFT
The home page link will be at bottom left corner. |
static int |
BOTTOM_RIGHT
The home page link will be at bottom right corner. |
boolean |
copyRightNeeded
|
int |
endIndex
|
java.lang.String |
filter
|
java.lang.String |
fontColor
|
java.lang.String |
fontFace
|
java.lang.String |
fontSize
|
java.lang.String |
footerMsg
|
int |
headerSize
|
int |
homePageLocation
|
java.lang.String |
indexFileName
|
boolean |
isJavaScript
|
boolean |
isNextButtonNeeded
|
boolean |
isOperations
|
boolean |
isOperationsLinkNeeded
|
boolean |
isPrevButtonNeeded
|
boolean |
isRefreshButtonNeeded
|
boolean |
isTextDecoration
|
boolean |
limitRestrictFlag
|
java.lang.String |
linkColor
|
java.lang.String |
listStringName
|
java.lang.String |
mailTo
|
int |
maxDispChar
|
int |
numRows
|
boolean |
operation
|
int |
refreshTime
Refresh time to update the displayed html page |
java.lang.String |
servletName
|
int |
stIndex
|
java.lang.String |
tabIndexColor
|
java.util.Hashtable |
table
|
java.lang.String |
tableHeaderColor
|
java.lang.String |
tableRowColor
|
int |
TOP_CENTER
The home page link will be at top center. |
int |
TOP_LEFT
The home page link will be at top left corner. |
int |
TOP_RIGHT
The home page link will be at top right corner. |
java.lang.String |
vlinkColor
|
Constructor Summary | |
HtmlPageProp()
|
Method Summary | |
java.lang.String |
getAlinkColor()
|
java.lang.Object |
getAttribute(java.lang.String attribute)
Gets the value of a specific attribute of this MBean. |
AttributeList |
getAttributes(java.lang.String[] attributes)
Enables the values of several attributes of this MBean. |
java.lang.String |
getAuthor()
|
java.lang.String |
getBackGroundColor()
|
java.lang.String |
getBackGroundImage()
|
java.util.Hashtable |
getConfTable(java.lang.String userName)
|
boolean |
getCopyRightNeeded()
|
java.lang.String |
getFontColor()
|
java.lang.String |
getFontFace()
|
java.lang.String |
getFontSize()
|
java.lang.String |
getFooterMessage()
|
java.util.Hashtable |
getHeaderTable()
|
java.lang.String |
getIndexFileName()
|
boolean |
getJavaScript()
|
boolean |
getLimitRestrictFlag()
|
java.lang.String |
getLinkColor()
|
java.lang.String |
getMailTo()
|
int |
getMaxDispChar()
|
MBeanInfo |
getMBeanInfo()
This method discovers the attributes and operations this MBean exposes for management. |
int |
getNumRows()
|
boolean |
getOperationsLinkNeeded()
|
int |
getRefreshTime()
|
java.lang.String |
getServletName()
|
java.lang.String |
getTabIndexColor()
|
java.lang.String |
getTableHeaderColor()
|
java.lang.String |
getTableRowColor()
|
boolean |
getTextDecoration()
|
java.lang.String |
getVlinkColor()
|
java.lang.Object |
invoke(java.lang.String actionName,
java.lang.Object[] params,
java.lang.String[] signature)
Invokes an action on this MBean. |
void |
readFromFile(java.lang.String userName)
|
void |
setAlinkColor(java.lang.String alinkColor)
|
void |
setAttribute(Attribute attribute)
Sets the value of a specific attribute of this MBean. |
AttributeList |
setAttributes(AttributeList attributes)
Sets the values of several attributes of this MBean. |
void |
setAuthor(java.lang.String auth)
|
void |
setBackGroundColor(java.lang.String bgColor)
|
void |
setBackGroundImage(java.lang.String bgImage)
|
void |
setCopyRightNeeded(boolean flag)
|
void |
setFontColor(java.lang.String fontColor)
|
void |
setFontFace(java.lang.String fontFace)
|
void |
setFontSize(java.lang.String fontSize)
|
void |
setFooterMessage(java.lang.String footer)
|
void |
setIndexFileName(java.lang.String fName)
|
void |
setJavaScript(boolean flag)
|
void |
setLimitRestrictFlag(boolean flag)
|
void |
setLinkColor(java.lang.String linkColor)
|
void |
setMailTo(java.lang.String mailTo)
|
void |
setMaxDispChar(java.lang.Integer maxDispChar)
|
void |
setNumRows(java.lang.Integer numrows)
|
void |
setOperationsLinkNeeded(boolean flag)
|
void |
setRefreshTime(java.lang.Integer refresh)
|
void |
setServletName(java.lang.String servlet)
|
void |
setTabIndexColor(java.lang.String tabIndexColor)
|
void |
setTableHeaderColor(java.lang.String scaTHColor)
|
void |
setTableRowColor(java.lang.String scaTRColor)
|
void |
setTextDecoration(boolean flag)
|
void |
setVlinkColor(java.lang.String vlinkColor)
|
void |
writeIntoFile(java.lang.String userName)
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public boolean operation
public java.util.Hashtable table
public boolean copyRightNeeded
public java.lang.String filter
public java.lang.String author
public java.lang.String indexFileName
public java.lang.String backGroundColor
public java.lang.String backGroundImage
public java.lang.String footerMsg
public java.lang.String servletName
public java.lang.String listStringName
public java.lang.String vlinkColor
public java.lang.String alinkColor
public java.lang.String linkColor
public java.lang.String tableHeaderColor
public java.lang.String tableRowColor
public java.lang.String tabIndexColor
public java.lang.String fontColor
public java.lang.String fontFace
public java.lang.String mailTo
public java.lang.String fontSize
public int maxDispChar
public int refreshTime
public int backTagLocation
public int homePageLocation
public int headerSize
public int TOP_LEFT
public int TOP_RIGHT
public int TOP_CENTER
public int BOTTOM_LEFT
public static int BOTTOM_RIGHT
public int BOTTOM_CENTER
public boolean isRefreshButtonNeeded
public boolean isNextButtonNeeded
public boolean isPrevButtonNeeded
public boolean isJavaScript
public boolean limitRestrictFlag
public boolean isOperationsLinkNeeded
public boolean isOperations
public boolean isTextDecoration
public int stIndex
public int endIndex
public int numRows
Constructor Detail |
public HtmlPageProp()
Method Detail |
public java.util.Hashtable getHeaderTable()
public boolean getCopyRightNeeded()
public void setCopyRightNeeded(boolean flag)
public boolean getTextDecoration()
public void setTextDecoration(boolean flag)
public boolean getJavaScript()
public void setJavaScript(boolean flag)
public boolean getLimitRestrictFlag()
public void setLimitRestrictFlag(boolean flag)
public boolean getOperationsLinkNeeded()
public void setOperationsLinkNeeded(boolean flag)
public int getMaxDispChar()
public void setMaxDispChar(java.lang.Integer maxDispChar)
public int getNumRows()
public void setNumRows(java.lang.Integer numrows) throws java.lang.Exception
public int getRefreshTime()
public void setRefreshTime(java.lang.Integer refresh)
public java.lang.String getBackGroundColor()
public void setBackGroundColor(java.lang.String bgColor)
public java.lang.String getVlinkColor()
public void setVlinkColor(java.lang.String vlinkColor)
public java.lang.String getLinkColor()
public void setLinkColor(java.lang.String linkColor)
public java.lang.String getAlinkColor()
public void setAlinkColor(java.lang.String alinkColor)
public java.lang.String getTableHeaderColor()
public void setTableHeaderColor(java.lang.String scaTHColor)
public java.lang.String getTableRowColor()
public void setTableRowColor(java.lang.String scaTRColor)
public java.lang.String getTabIndexColor()
public void setTabIndexColor(java.lang.String tabIndexColor)
public java.lang.String getFontColor()
public void setFontColor(java.lang.String fontColor)
public java.lang.String getFontFace()
public void setFontFace(java.lang.String fontFace)
public java.lang.String getMailTo()
public void setMailTo(java.lang.String mailTo)
public java.lang.String getFontSize()
public void setFontSize(java.lang.String fontSize)
public java.lang.String getBackGroundImage()
public void setBackGroundImage(java.lang.String bgImage)
public java.lang.String getServletName()
public void setServletName(java.lang.String servlet)
public java.lang.String getIndexFileName()
public void setIndexFileName(java.lang.String fName)
public java.lang.String getFooterMessage()
public void setFooterMessage(java.lang.String footer)
public java.lang.String getAuthor()
public void setAuthor(java.lang.String auth)
public void readFromFile(java.lang.String userName)
public java.util.Hashtable getConfTable(java.lang.String userName)
public void writeIntoFile(java.lang.String userName)
public MBeanInfo getMBeanInfo()
getMBeanInfo
in interface DynamicMBean
public java.lang.Object getAttribute(java.lang.String attribute) throws AttributeNotFoundException, MBeanException, ReflectionException
getAttribute
in interface DynamicMBean
attribute
- A String specifying the name of the
attribute to be retrieved.AttributeNotFoundException
- The
specified attribute is not accessible in the MBean.MBeanException
- The constructor of the MBean has
thrown an exceptionReflectionException
- Wraps a
ClassNotFoundException or a java.lang.Exception that occured trying to
invoke the MBean's constructor.public AttributeList getAttributes(java.lang.String[] attributes)
getAttributes
in interface DynamicMBean
attributes
- A list of attributes to be retrieved.public java.lang.Object invoke(java.lang.String actionName, java.lang.Object[] params, java.lang.String[] signature) throws MBeanException, ReflectionException
invoke
in interface DynamicMBean
actionName
- The name of the action to be invoked.params
- An array containing the parameters to be
set when the action is invokedsignature
- An array containing the signature of
the action. The class objects will be loaded using the
same class loader as the one used for loading the MBean
on which the action was invoked.MBeanException
- The constructor of the MBean has
thrown an exceptionReflectionException
- Wraps a
ClassNotFoundException or a java.lang.Exception that occured trying to
invoke the MBean's constructor.public void setAttribute(Attribute attribute) throws AttributeNotFoundException, InvalidAttributeValueException, MBeanException, ReflectionException
setAttribute
in interface DynamicMBean
attribute
- The identification of the attribute to
be set and the value it is to be set to.AttributeNotFoundException
- The
specified attribute is not accessible in the MBean.InvalidAttributeValueException
- The
specified value for the attribute is not valid.MBeanException
- The constructor of the MBean has
thrown an exceptionReflectionException
- Wraps a
ClassNotFoundException or a java.lang.Exception that occured trying to
invoke the MBean's constructor.public AttributeList setAttributes(AttributeList attributes)
setAttributes
in interface DynamicMBean
attributes
- A list of attributes: The identification
of the attributes to be set and the values they are to be set to.
|
XMOJO 5 API Docs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |