Component (webclient 7.5.6 API)

java.lang.Object
- com.saperion.ngc.viewer.virtualviewer.annotation.ini.Component

Direct Known Subclasses:

Arrow, Custom, Freehand, Highlight, HighlightPolygon, Line, Note, OpenPolygon, Oval, Polygon, Rectangle, Redact, RedactPolygon, Stamp, Text
```
public class Component
extends Object
```
The General Component Class for ini Components.

Author:

jek

Constructor Summary

Constructors
Constructor and Description

Component()

Constructors
Constructor and Description
`Component()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Integer`	`getArrowHeadSize()`
`String`	`getAspectRatio()`
`String`	`getBlankOutImage()`
`String`	`getBorder()`
`Color`	`getColor()`
`String`	`getCreateDate()`
`String`	`getCreatedId()`
`Integer`	`getCustomerProperty()`
`Integer`	`getEdit()`
`Color`	`getFillColor()`
`String`	`getFontBold()`
`Integer`	`getFontHeight()`
`String`	`getFontItalic()`
`String`	`getFontName()`
`String`	`getFontStrikeThrough()` Is a text striked through.
`String`	`getFontUnderline()`
`String`	`getFrames()`
`Integer`	`getHeight()`
`String`	`getHyperlink()`
`String`	`getHyperLinkSettings()`
`String`	`getLabel()`
`Integer`	`getLineWidth()`
`String`	`getModifiedDate()`
`String`	`getModifiedId()`
`Integer`	`getPage()`
`String`	`getPageSize()`
`String`	`getPageUrl()`
`Integer`	`getRectangular()`
`String`	`getResource()`
`Integer`	`getRotation()`
`String`	`getScale()`
`Integer`	`getSemiTransparent()`
`Integer`	`getStrikeThrough()`
`String`	`getText()`
`Integer`	`getTextRotation()`
`Integer`	`getTransparent()`
`String`	`getType()`
`Integer`	`getView()`
`Integer`	`getWidth()`
`Node`	`getXy()`
`Node`	`getXy1()`
`Node`	`getXy2()`
`ArrayList<Node>`	`getXyn()`
`String`	`renderComponent()`
`String`	`renderKeyValue(String key, String value)`
`String`	`renderKeyValue(String key, String value, String delimiter)`
`String`	`renderNode(String keyX, String keyY, Node node)`
`String`	`renderNode(String keyX, String keyY, Node node, String delimiter)`
`String`	`renderType()`
`void`	`setArrowHeadSize(Integer aArrowHeadSize)`
`void`	`setAspectRatio(String aAspectRatio)`
`void`	`setBlankOutImage(String aBlankOutImage)`
`void`	`setBorder(String aBorder)`
`void`	`setColor(Color aColor)`
`void`	`setCreateDate(String aCreateDate)`
`void`	`setCreatedId(String aCreatedId)`
`void`	`setCustomProperty(Integer aCustomProperty)`
`void`	`setEdit(Integer aEdit)`
`void`	`setFillColor(Color aFillColor)`
`void`	`setFontBold(String fontBold)`
`void`	`setFontHeight(Integer aFontHeight)`
`void`	`setFontItalic(String fontItalic)`
`void`	`setFontName(String aFontName)`
`void`	`setFontStrikeThrough(String fontStrikeThrough)`
`void`	`setFontUnderline(String fontUnderline)`
`void`	`setFrames(String aFrames)`
`void`	`setHeight(Integer aHeight)`
`void`	`setHyperlink(String aHyperlink)`
`void`	`setHyperLinkSettings(String aHyperLinkSettings)`
`void`	`setLabel(String aLabel)`
`void`	`setLineWidth(Integer aLineWidth)`
`void`	`setModifiedDate(String aModifiedDate)`
`void`	`setModifiedId(String aModifiedId)`
`void`	`setPage(Integer aPage)`
`void`	`setPageSize(String aPageSize)`
`void`	`setPageUrl(String aPageUrl)`
`void`	`setRectangular(Integer aRectangular)`
`void`	`setResource(String aResource)`
`void`	`setRotation(Integer aRotation)`
`void`	`setScale(String aScale)`
`void`	`setSemiTransparent(Integer aSemiTransparent)`
`void`	`setStrikeThrough(Integer aStrikeThrough)`
`void`	`setText(String aText)`
`void`	`setTextRotation(Integer aTextRotation)`
`void`	`setTransparent(Integer aTransparent)`
`void`	`setType(String aType)`
`void`	`setView(Integer aView)`
`void`	`setWidth(Integer aWidth)`
`void`	`setXy(Node aXy)`
`void`	`setXy1(Node aXy1)`
`void`	`setXy2(Node aXy2)`
`void`	`setXyn(ArrayList<Node> aXyn)`

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

Constructor Detail
- Component
```
public Component()
```

Method Detail

getType
```
public String getType()
```
Returns:

the type

setType
```
public void setType(String aType)
```
Parameters:

aType - the type to set

getXy
```
public Node getXy()
```
Returns:

the xy

setXy
```
public void setXy(Node aXy)
```
Parameters:

aXy - the xy to set

getXy1
```
public Node getXy1()
```
Returns:

the xy1

setXy1
```
public void setXy1(Node aXy1)
```
Parameters:

aXy1 - the xy1 to set

getXy2
```
public Node getXy2()
```
Returns:

the xy2

setXy2
```
public void setXy2(Node aXy2)
```
Parameters:

aXy2 - the xy2 to set

getXyn
```
public ArrayList<Node> getXyn()
```
Returns:

the xyn

setXyn

public void setXyn(ArrayList<Node> aXyn)

Parameters:: aXyn - the xyn to set

getPage
```
public Integer getPage()
```
Returns:

the page

setPage
```
public void setPage(Integer aPage)
```
Parameters:

aPage - the page to set

getPageUrl
```
public String getPageUrl()
```
Returns:

the pageUrl

setPageUrl
```
public void setPageUrl(String aPageUrl)
```
Parameters:

aPageUrl - the pageUrl to set

getPageSize
```
public String getPageSize()
```
Returns:

the pageSize

setPageSize
```
public void setPageSize(String aPageSize)
```
Parameters:

aPageSize - the pageSize to set

getEdit
```
public Integer getEdit()
```
Returns:

the edit

setEdit
```
public void setEdit(Integer aEdit)
```
Parameters:

aEdit - the edit to set

getWidth
```
public Integer getWidth()
```
Returns:

the width

setWidth
```
public void setWidth(Integer aWidth)
```
Parameters:

aWidth - the width to set

getHeight
```
public Integer getHeight()
```
Returns:

the height

setHeight
```
public void setHeight(Integer aHeight)
```
Parameters:

aHeight - the height to set

getArrowHeadSize
```
public Integer getArrowHeadSize()
```
Returns:

the arrowHeadSize

setArrowHeadSize
```
public void setArrowHeadSize(Integer aArrowHeadSize)
```
Parameters:

aArrowHeadSize - the arrowHeadSize to set

getLineWidth
```
public Integer getLineWidth()
```
Returns:

the lineWidth

setLineWidth
```
public void setLineWidth(Integer aLineWidth)
```
Parameters:

aLineWidth - the lineWidth to set

getAspectRatio
```
public String getAspectRatio()
```
Returns:

the aspectRatio

setAspectRatio
```
public void setAspectRatio(String aAspectRatio)
```
Parameters:

aAspectRatio - the aspectRatio to set

getLabel
```
public String getLabel()
```
Returns:

the label

setLabel
```
public void setLabel(String aLabel)
```
Parameters:

aLabel - the label to set

getText
```
public String getText()
```
Returns:

the text

setText
```
public void setText(String aText)
```
Parameters:

aText - the text to set

getTransparent
```
public Integer getTransparent()
```
Returns:

the transparent

setTransparent
```
public void setTransparent(Integer aTransparent)
```
Parameters:

aTransparent - the transparent to set

getRectangular
```
public Integer getRectangular()
```
Returns:

the rectangular

setRectangular
```
public void setRectangular(Integer aRectangular)
```
Parameters:

aRectangular - the rectangular to set

getResource
```
public String getResource()
```
Returns:

the resource

setResource
```
public void setResource(String aResource)
```
Parameters:

aResource - the resource to set

getRotation
```
public Integer getRotation()
```
Returns:

the rotation

setRotation
```
public void setRotation(Integer aRotation)
```
Parameters:

aRotation - the rotation to set

getView
```
public Integer getView()
```
Returns:

the view

setView
```
public void setView(Integer aView)
```
Parameters:

aView - the view to set

getColor
```
public Color getColor()
```
Returns:

the color

setColor
```
public void setColor(Color aColor)
```
Parameters:

aColor - the color to set

getFillColor
```
public Color getFillColor()
```
Returns:

the fillColor

setFillColor
```
public void setFillColor(Color aFillColor)
```
Parameters:

aFillColor - the fillColor to set

getCreateDate
```
public String getCreateDate()
```
Returns:

the createDate

setCreateDate
```
public void setCreateDate(String aCreateDate)
```
Parameters:

aCreateDate - the createDate to set

getModifiedDate
```
public String getModifiedDate()
```
Returns:

the modifiedDate

setModifiedDate
```
public void setModifiedDate(String aModifiedDate)
```
Parameters:

aModifiedDate - the modifiedDate to set

getCreatedId
```
public String getCreatedId()
```
Returns:

the createdId

setCreatedId
```
public void setCreatedId(String aCreatedId)
```
Parameters:

aCreatedId - the createdId to set

getModifiedId
```
public String getModifiedId()
```
Returns:

the modifiedId

setModifiedId
```
public void setModifiedId(String aModifiedId)
```
Parameters:

aModifiedId - the modifiedId to set

getBlankOutImage
```
public String getBlankOutImage()
```
Returns:

the blankOutImage

setBlankOutImage
```
public void setBlankOutImage(String aBlankOutImage)
```
Parameters:

aBlankOutImage - the blankOutImage to set

getCustomerProperty
```
public Integer getCustomerProperty()
```
Returns:

the customerProperty

setCustomProperty
```
public void setCustomProperty(Integer aCustomProperty)
```
Parameters:

aCustomProperty - the customProperty to set

getHyperlink
```
public String getHyperlink()
```
Returns:

the hyperlink

setHyperlink
```
public void setHyperlink(String aHyperlink)
```
Parameters:

aHyperlink - the aHyperlink to set

getHyperLinkSettings
```
public String getHyperLinkSettings()
```
Returns:

the hyperLinkSettings

setHyperLinkSettings
```
public void setHyperLinkSettings(String aHyperLinkSettings)
```
Parameters:

aHyperLinkSettings - the hyperLinkSettings to set

getFontName
```
public String getFontName()
```
Returns:

the fontType

setFontName
```
public void setFontName(String aFontName)
```
Parameters:

aFontName - the fontType to set

getFontHeight
```
public Integer getFontHeight()
```
Returns:

the fontHeight

setFontHeight
```
public void setFontHeight(Integer aFontHeight)
```
Parameters:

aFontHeight - the fontHeight to set

getFontBold
```
public String getFontBold()
```

setFontBold

public void setFontBold(String fontBold)

getFontStrikeThrough
```
public String getFontStrikeThrough()
```
Is a text striked through.

setFontStrikeThrough
```
public void setFontStrikeThrough(String fontStrikeThrough)
```
Parameters:

fontStrikeThrough - Set if a text striked through.

getFontUnderline
```
public String getFontUnderline()
```

setFontUnderline

public void setFontUnderline(String fontUnderline)

getFontItalic
```
public String getFontItalic()
```

setFontItalic

public void setFontItalic(String fontItalic)

getTextRotation
```
public Integer getTextRotation()
```
Returns:

the textRotation

setTextRotation
```
public void setTextRotation(Integer aTextRotation)
```
Parameters:

aTextRotation - the textRotation to set

getSemiTransparent
```
public Integer getSemiTransparent()
```
Returns:

the semiTransparent

setSemiTransparent
```
public void setSemiTransparent(Integer aSemiTransparent)
```
Parameters:

aSemiTransparent - the semiTransparent to set

getStrikeThrough
```
public Integer getStrikeThrough()
```
Returns:

the strikeThrough

setStrikeThrough
```
public void setStrikeThrough(Integer aStrikeThrough)
```
Parameters:

aStrikeThrough - the strikeThrough to set

getBorder
```
public String getBorder()
```
Returns:

the border

setBorder
```
public void setBorder(String aBorder)
```
Parameters:

aBorder - the border to set

getFrames
```
public String getFrames()
```
Returns:

the frames

setFrames
```
public void setFrames(String aFrames)
```
Parameters:

aFrames - the frames to set

getScale
```
public String getScale()
```
Returns:

the scale

setScale
```
public void setScale(String aScale)
```
Parameters:

aScale - the scale to set

renderType
```
public String renderType()
```
Returns:

rendered Type header

renderKeyValue

public String renderKeyValue(String key,
                             String value)

Parameters:: key - key; value - value
Returns:: rendered key value pair

renderKeyValue

public String renderKeyValue(String key,
                             String value,
                             String delimiter)

Parameters:: key - key; value - value; delimiter - Delimiter
Returns:: rendered key value pair

renderNode

public String renderNode(String keyX,
                         String keyY,
                         Node node)

Parameters:: keyX - keyX; keyY - keyY; node - node
Returns:: rendered key value pair

renderNode

public String renderNode(String keyX,
                         String keyY,
                         Node node,
                         String delimiter)

Parameters:: keyX - keyX; keyY - keyY; node - node; delimiter - Delimiter
Returns:: rendered key value pair

renderComponent
```
public String renderComponent()
```
Returns:

rendered component Array

Class Component

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Component

Method Detail

getType

setType

getXy

setXy

getXy1

setXy1

getXy2

setXy2

getXyn

setXyn

getPage

setPage

getPageUrl

setPageUrl

getPageSize

setPageSize

getEdit

setEdit

getWidth

setWidth

getHeight

setHeight

getArrowHeadSize

setArrowHeadSize

getLineWidth

setLineWidth

getAspectRatio

setAspectRatio

getLabel

setLabel

getText

setText

getTransparent

setTransparent

getRectangular

setRectangular

getResource

setResource

getRotation

setRotation

getView

setView

getColor

setColor

getFillColor

setFillColor

getCreateDate

setCreateDate

getModifiedDate

setModifiedDate

getCreatedId

setCreatedId

getModifiedId

setModifiedId

getBlankOutImage

setBlankOutImage

getCustomerProperty

setCustomProperty

getHyperlink

setHyperlink

getHyperLinkSettings

setHyperLinkSettings

getFontName

setFontName

getFontHeight

setFontHeight

getFontBold

setFontBold

getFontStrikeThrough

setFontStrikeThrough

getFontUnderline

setFontUnderline

getFontItalic