DiagramHeaderFooter
Inheritance: java.lang.Object
public class DiagramHeaderFooter
Represents a header/footer in a Visio document.
Methods
| Method | Description |
|---|---|
| getHeaderLeft() | Gets the text string that appears in the left portion of document header. |
| setHeaderLeft(String value) | Sets the text string that appears in the left portion of document header. |
| getHeaderCenter() | Gets the text string that appears in the center portion of document header. |
| setHeaderCenter(String value) | Sets the text string that appears in the center portion of document header. |
| getHeaderRight() | Gets the text string that appears in the right portion of document header. |
| setHeaderRight(String value) | Sets the text string that appears in the right portion of document header. |
| getFooterLeft() | Gets the text string that appears in the left portion of document footer. |
| setFooterLeft(String value) | Sets the text string that appears in the left portion of document footer. |
| getFooterCenter() | Gets the text string that appears in the center portion of document footer. |
| setFooterCenter(String value) | Sets the text string that appears in the center portion of document footer. |
| getFooterRight() | Gets the text string that appears in the right portion of document footer. |
| setFooterRight(String value) | Sets the text string that appears in the right portion of document footer. |
| getHeaderMargin() | Gets the margin of document header. |
| setHeaderMargin(double value) | Sets the margin of document header. |
| getFooterMargin() | Gets the margin of document header. |
| setFooterMargin(double value) | Sets the margin of document header. |
| getTextColor() | Gets the text color for header and footer. |
| setTextColor(Color value) | Sets the text color for header and footer. |
| getFont() | Gets the font used for header and footer text. |
| getByDiagramHeaderFooterType(int headerFooterType) | |
| setByDiagramHeaderFooterType(int headerFooterType, String value) |
getHeaderLeft()
public final String getHeaderLeft()
Gets the text string that appears in the left portion of document header.
Returns: java.lang.String - The text string that appears in the left portion of document header.
setHeaderLeft(String value)
public final void setHeaderLeft(String value)
Sets the text string that appears in the left portion of document header.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String | The text string that appears in the left portion of document header. |
getHeaderCenter()
public final String getHeaderCenter()
Gets the text string that appears in the center portion of document header.
Returns: java.lang.String - The text string that appears in the center portion of document header.
setHeaderCenter(String value)
public final void setHeaderCenter(String value)
Sets the text string that appears in the center portion of document header.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String | The text string that appears in the center portion of document header. |
getHeaderRight()
public final String getHeaderRight()
Gets the text string that appears in the right portion of document header.
Returns: java.lang.String - The text string that appears in the right portion of document header.
setHeaderRight(String value)
public final void setHeaderRight(String value)
Sets the text string that appears in the right portion of document header.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String | The text string that appears in the right portion of document header. |
getFooterLeft()
public final String getFooterLeft()
Gets the text string that appears in the left portion of document footer.
Returns: java.lang.String - The text string that appears in the left portion of document footer.
setFooterLeft(String value)
public final void setFooterLeft(String value)
Sets the text string that appears in the left portion of document footer.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String | The text string that appears in the left portion of document footer. |
getFooterCenter()
public final String getFooterCenter()
Gets the text string that appears in the center portion of document footer.
Returns: java.lang.String - The text string that appears in the center portion of document footer.
setFooterCenter(String value)
public final void setFooterCenter(String value)
Sets the text string that appears in the center portion of document footer.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String | The text string that appears in the center portion of document footer. |
getFooterRight()
public final String getFooterRight()
Gets the text string that appears in the right portion of document footer.
Returns: java.lang.String - The text string that appears in the right portion of document footer.
setFooterRight(String value)
public final void setFooterRight(String value)
Sets the text string that appears in the right portion of document footer.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String | The text string that appears in the right portion of document footer. |
getHeaderMargin()
public final double getHeaderMargin()
Gets the margin of document header.
Returns: double - The margin of document header.
setHeaderMargin(double value)
public final void setHeaderMargin(double value)
Sets the margin of document header.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | double | The margin of document header. |
getFooterMargin()
public final double getFooterMargin()
Gets the margin of document header.
Returns: double - The margin of document header.
setFooterMargin(double value)
public final void setFooterMargin(double value)
Sets the margin of document header.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | double | The margin of document header. |
getTextColor()
public final Color getTextColor()
Gets the text color for header and footer.
Returns: Color - The text color for header and footer.
setTextColor(Color value)
public final void setTextColor(Color value)
Sets the text color for header and footer.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | Color | The text color for header and footer. |
getFont()
public final DiagramHeaderFooterFont getFont()
Gets the font used for header and footer text.
Returns: DiagramHeaderFooterFont - The font used for header and footer text.
getByDiagramHeaderFooterType(int headerFooterType)
public final String getByDiagramHeaderFooterType(int headerFooterType)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| headerFooterType | int |
Returns: java.lang.String
setByDiagramHeaderFooterType(int headerFooterType, String value)
public final void setByDiagramHeaderFooterType(int headerFooterType, String value)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| headerFooterType | int | |
| value | java.lang.String |