Package org.apache.poi.hslf.usermodel
Class HSLFPlaceholderDetails
java.lang.Object
org.apache.poi.hslf.usermodel.HSLFPlaceholderDetails
- All Implemented Interfaces:
PlaceholderDetails
- Direct Known Subclasses:
HSLFShapePlaceholderDetails
Extended placeholder details for HSLF sheets - mainly for headers and footers
- Since:
- POI 4.0.0
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.apache.poi.sl.usermodel.PlaceholderDetails
PlaceholderDetails.PlaceholderSize -
Method Summary
Modifier and TypeMethodDescriptiongetSize()getText()If the placeholder shape or object stores text, this text is returned otherwisenull.booleanvoidsetPlaceholder(Placeholder placeholder) Specifies that the corresponding shape should be represented by the generating application as a placeholder.voidvoidIf the placeholder shape or object stores text, the given text is stored otherwise this is a no-op.voidsetVisible(boolean isVisible)
-
Method Details
-
isVisible
public boolean isVisible()- Specified by:
isVisiblein interfacePlaceholderDetails
-
setVisible
public void setVisible(boolean isVisible) - Specified by:
setVisiblein interfacePlaceholderDetails
-
getPlaceholder
- Specified by:
getPlaceholderin interfacePlaceholderDetails
-
setPlaceholder
Description copied from interface:PlaceholderDetailsSpecifies that the corresponding shape should be represented by the generating application as a placeholder. When a shape is considered a placeholder by the generating application it can have special properties to alert the user that they may enter content into the shape. Different types of placeholders are allowed and can be specified by using the placeholder type attribute for this element- Specified by:
setPlaceholderin interfacePlaceholderDetails- Parameters:
placeholder- The shape to use as placeholder or null if no placeholder should be set.
-
getSize
- Specified by:
getSizein interfacePlaceholderDetails
-
setSize
- Specified by:
setSizein interfacePlaceholderDetails
-
getText
Description copied from interface:PlaceholderDetailsIf the placeholder shape or object stores text, this text is returned otherwisenull.- Specified by:
getTextin interfacePlaceholderDetails- Returns:
- the text of the shape / placeholder
-
setText
Description copied from interface:PlaceholderDetailsIf the placeholder shape or object stores text, the given text is stored otherwise this is a no-op.- Specified by:
setTextin interfacePlaceholderDetails- Parameters:
text- the placeholder text
-