com.herewhite.sdk.domain.MemberState class 参考
- Android
更新时间不可用
详细描述
适用版本:Whiteboard Android SDK 2.16.134。
MemberState 类,用于设置互动白板实时房间的白板工具状态。
父类:WhiteObject;继承接口详见父类。
属性与 JSON 字段
Java 非公开字段通过对应 getter/setter 访问;可选包装类型未设置时通常不写入 JSON。初值包含字段声明及无参构造中的直接赋值;其他构造参数以签名为准。
| 字段 | 声明 | 源码初值 | 说明 |
|---|---|---|---|
| currentApplianceName | String currentApplianceName | 未显式赋值 | 白板工具名称,详见 Appliance。 |
| shapeType | ShapeType shapeType | 未显式赋值 | 图形工具的类型。 |
| strokeColor | int[] strokeColor | 未显式赋值 | 线条颜色,为 RGB 格式,例如,[0, 0, 255] 表示蓝色。 |
| strokeWidth | Double strokeWidth | 未显式赋值 | 线条粗细。 |
| textSize | Double textSize | 未显式赋值 | 字体大小。Chrome 浏览器对于小于 12 的字体会自动调整为 12。 |
| textColor | int[] textColor | 未显式赋值 | 文本颜色,为 RGB 格式,例如,[0, 0, 255] 表示蓝色。 |
| textCanSelectText | Boolean textCanSelectText | 未显式赋值 | 文本是否可直接选择 |
| dottedLine | Boolean dottedLine | 未显式赋值 | 新铅笔是否画虚线 |
| pencilEraserSize | Integer pencilEraserSize | 未显式赋值 | 铅笔橡皮的尺寸,取值 1~3 |
| strokeType | StrokeType strokeType | 未显式赋值 | 模型属性;通过对应 getter/setter 访问。 |
| strokeOpacity | Double strokeOpacity | 未显式赋值 | 线条透明度。 |
| fillOpacity | Double fillOpacity | 未显式赋值 | 图形填充透明度。 |
| fillColor | int[] fillColor | 未显式赋值 | 图形填充颜色,为 RGB 格式,例如,[0, 0, 255] 表示蓝色。 |
| 公开成员签名 | |
|---|---|
| MemberState () | |
| String | getCurrentApplianceName () |
| void | setCurrentApplianceName (String currentApplianceName) |
| void | setCurrentApplianceName (String currentApplianceName, ShapeType shapeType) |
| ShapeType | getShapeType () |
| void | setShapeType (ShapeType shapeType) |
| int[] | getStrokeColor () |
| void | setStrokeColor (int[] strokeColor) |
| int[] | getTextColor () |
| void | setTextColor (int[] textColor) |
| double | getStrokeWidth () |
| void | setStrokeWidth (double strokeWidth) |
| double | getTextSize () |
| void | setTextSize (double textSize) |
| Boolean | getTextCanSelectText () |
| void | setTextCanSelectText (Boolean textCanSelectText) |
| Boolean | getDottedLine () |
| void | setDottedLine (Boolean dottedLine) |
| Integer | getPencilEraserSize () |
| void | setPencilEraserSize (Integer pencilEraserSize) |
| StrokeType | getStrokeType () |
| void | setStrokeType (StrokeType strokeType) |
| Double | getStrokeOpacity () |
| void | setStrokeOpacity (Double strokeOpacity) |
| Double | getFillOpacity () |
| void | setFillOpacity (Double fillOpacity) |
| int[] | getFillColor () |
| void | setFillColor (int[] fillColor) |
变量说明
currentApplianceName
String currentApplianceName源码初值:未显式赋值
白板工具名称,详见 Appliance。
shapeType
ShapeType shapeType源码初值:未显式赋值
图形工具的类型。
strokeColor
int[] strokeColor源码初值:未显式赋值
线条颜色,为 RGB 格式,例如,[0, 0, 255] 表示蓝色。
strokeWidth
Double strokeWidth源码初值:未显式赋值
线条粗细。
textSize
Double textSize源码初值:未显式赋值
字体大小。Chrome 浏览器对于小于 12 的字体会自动调整为 12。
textColor
int[] textColor源码初值:未显式赋值
文本颜色,为 RGB 格式,例如,[0, 0, 255] 表示蓝色。
textCanSelectText
Boolean textCanSelectText源码初值:未显式赋值
文本是否可直接选择
dottedLine
Boolean dottedLine源码初值:未显式赋值
新铅笔是否画虚线
pencilEraserSize
Integer pencilEraserSize源码初值:未显式赋值
铅笔橡皮的尺寸,取值 1~3
strokeType
StrokeType strokeType源码初值:未显式赋值
模型属性;通过对应 getter/setter 访问。
strokeOpacity
Double strokeOpacity源码初值:未显式赋值
线条透明度。
fillOpacity
Double fillOpacity源码初值:未显式赋值
图形填充透明度。
fillColor
int[] fillColor源码初值:未显式赋值
图形填充颜色,为 RGB 格式,例如,[0, 0, 255] 表示蓝色。
函数说明
MemberState()
MemberState()MemberState:com.herewhite.sdk.domain.MemberState 的公开成员。参数和返回类型见下方签名。
getCurrentApplianceName()
String getCurrentApplianceName()获取互动白板实时房间内当前使用的白板工具名称。
返回值
互动白板实时房间内当前使用的白板工具名称。
setCurrentApplianceName()
void setCurrentApplianceName(String currentApplianceName)设置互动白板实时房间内使用的白板工具。
| 参数名 | 描述 |
|---|---|
currentApplianceName | 白板工具名称,详见 |
setCurrentApplianceName()
void setCurrentApplianceName(String currentApplianceName, ShapeType shapeType)设置互动白板实时房间内使用的白板工具。
getShapeType()
ShapeType getShapeType()获取图形工具的类型。
自从
2.12.26
返回值
图形工具的类型。详见 ShapeType。
setShapeType()
void setShapeType(ShapeType shapeType)设置图形工具的类型。
自从
2.12.26
| 参数名 | 描述 |
|---|---|
shapeType | 图形工具的类型。详见 |
getStrokeColor()
int[] getStrokeColor()获取用户设置的线条颜色。
返回值
线条颜色,为 RGB 格式,例如,[0, 0, 255] 表示蓝色。
setStrokeColor()
void setStrokeColor(int[] strokeColor)设置线条颜色。
| 参数名 | 描述 |
|---|---|
strokeColor | 线条颜色,为 RGB 格式,例如,[0, 0, 255] 表示蓝色。 |
getTextColor()
int[] getTextColor()获取文本工具中文字的颜色。
返回值
文本颜色的数组。
setTextColor()
void setTextColor(int[] textColor)设置文本工具中文字的颜色。
| 参数名 | 描述 |
|---|---|
textColor | 文本颜色的数组。 |
getStrokeWidth()
double getStrokeWidth()获取用户设置的线条粗细。
返回值
线条粗细。
setStrokeWidth()
void setStrokeWidth(double strokeWidth)设置线条粗细。
| 参数名 | 描述 |
|---|---|
strokeWidth | 线条粗细。 |
getTextSize()
double getTextSize()获取用户设置的字体大小。
返回值
字体大小。
setTextSize()
void setTextSize(double textSize)设置字体大小。
| 参数名 | 描述 |
|---|---|
textSize | 字体大小。Chrome 浏览器对于小于 12 的字体会自动调整为 12。 |
getTextCanSelectText()
Boolean getTextCanSelectText()获取文本是否可直接选择并编辑。
返回值
是否开启文本可选择并编辑。
setTextCanSelectText()
void setTextCanSelectText(Boolean textCanSelectText)设置文字是否可以直接选择并编辑。
| 参数名 | 描述 |
|---|---|
textCanSelectText | 文字是否可否直接选择并编辑:
|
getDottedLine()
Boolean getDottedLine()获取新铅笔是否画虚线。
返回值
是否画虚线。
setDottedLine()
void setDottedLine(Boolean dottedLine)设置铅笔工具画虚线。 如需更改此配置,需要在加入房间时设置 (false)}。
| 参数名 | 描述 |
|---|---|
dottedLine | 是否画虚线。
|
getPencilEraserSize()
Integer getPencilEraserSize()获取铅笔橡皮的尺寸。
setPencilEraserSize()
void setPencilEraserSize(Integer pencilEraserSize)设置铅笔橡皮的尺寸 如需更改此配置,需要在加入房间时设置 (false)}。
| 参数名 | 描述 |
|---|---|
pencilEraserSize | 铅笔橡皮的尺寸,取值范围为 [1,3],值越大尺寸越大。 |
getStrokeType()
StrokeType getStrokeType()getStrokeType:com.herewhite.sdk.domain.MemberState 的公开成员。参数和返回类型见下方签名。
setStrokeType()
void setStrokeType(StrokeType strokeType)setStrokeType:com.herewhite.sdk.domain.MemberState 的公开成员。参数和返回类型见下方签名。
getStrokeOpacity()
Double getStrokeOpacity()获取线条透明度。
自从
2.16.100
返回值
线条透明度。取值范围为 [0.0, 1.0],0 表示完全透明,1 表示完全不透明。
setStrokeOpacity()
void setStrokeOpacity(Double strokeOpacity)设置线条透明度。
自从
2.16.100
| 参数名 | 描述 |
|---|---|
strokeOpacity | 线条透明度。取值范围为 [0.0, 1.0],0 表示完全透明,1 表示完全不透明。 |
getFillOpacity()
Double getFillOpacity()获取图形填充透明度。
自从
2.16.100
返回值
图形填充透明度。取值范围为 [0.0, 1.0],0 表示完全透明,1 表示完全不透明。
setFillOpacity()
void setFillOpacity(Double fillOpacity)设置图形填充透明度。
自从
2.16.100
| 参数名 | 描述 |
|---|---|
fillOpacity | 图形填充透明度。 |
getFillColor()
int[] getFillColor()获取图形填充颜色。
自从
2.16.100
返回值
图形填充颜色,为 RGB 格式,例如,[0, 0, 255] 表示蓝色。
setFillColor()
void setFillColor(int[] fillColor)设置图形填充颜色。
自从
2.16.100
| 参数名 | 描述 |
|---|---|
fillColor | 图形填充颜色,为 RGB 格式,例如,[0, 0, 255] 表示蓝色。 |