Top Description Inners Methods
org.apache.poi.sl.usermodel

public Interface PlaceholderDetails

Imports
java.time.format.DateTimeFormatter
Extended details about placholders
Since
POI 4.0.0

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum
PlaceholderDetails.PlaceholderSize

Method Summary

Modifier and TypeMethod and Description
public default DateTimeFormatter

Returns:

Get the date format for the datetime placeholder
getDateFormat()

public Placeholder
getPlaceholder()

public PlaceholderDetails.PlaceholderSize
getSize()

public String

Returns:

the text of the shape / placeholder
getText()

If the placeholder shape or object stores text, this text is returned otherwise null.

public default String

Returns:

the stored / fixed user specified date
getUserDate()

public boolean
isVisible()

public void
setPlaceholder(Placeholder
The shape to use as placeholder or null if no placeholder should be set.
placeholder)

Specifies that the corresponding shape should be represented by the generating application as a placeholder.

public void
setSize(PlaceholderDetails.PlaceholderSize size)

public void
setText(String
the placeholder text
text)

If the placeholder shape or object stores text, the given text is stored otherwise this is a no-op.

public void
setVisible(boolean isVisible)

Method Detail

getDateFormatback to summary
public default DateTimeFormatter getDateFormat()
Returns:DateTimeFormatter

Get the date format for the datetime placeholder

Since
POI 5.2.0
getPlaceholderback to summary
public Placeholder getPlaceholder()
getSizeback to summary
public PlaceholderDetails.PlaceholderSize getSize()
getTextback to summary
public String getText()

If the placeholder shape or object stores text, this text is returned otherwise null.

Returns:String

the text of the shape / placeholder

Since
POI 4.0.0
getUserDateback to summary
public default String getUserDate()
Returns:String

the stored / fixed user specified date

Since
POI 5.2.0
isVisibleback to summary
public boolean isVisible()
setPlaceholderback to summary
public void setPlaceholder(Placeholder placeholder)

Specifies 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

Parameters
placeholder:Placeholder

The shape to use as placeholder or null if no placeholder should be set.

setSizeback to summary
public void setSize(PlaceholderDetails.PlaceholderSize size)
setTextback to summary
public void setText(String text)

If the placeholder shape or object stores text, the given text is stored otherwise this is a no-op.

Parameters
text:String

the placeholder text

Since
POI 4.0.0
setVisibleback to summary
public void setVisible(boolean isVisible)
org.apache.poi.sl.usermodel back to summary

public final Enum PlaceholderDetails.PlaceholderSize

extends Enum<PlaceholderDetails.PlaceholderSize>
Class Inheritance

Field Summary

Modifier and TypeField and Description
public static final PlaceholderDetails.PlaceholderSize
full

public static final PlaceholderDetails.PlaceholderSize
half

public static final PlaceholderDetails.PlaceholderSize
quarter

Constructor Summary

AccessConstructor and Description
private
PlaceholderSize()

Method Summary

Modifier and TypeMethod and Description
public static PlaceholderDetails.PlaceholderSize
valueOf(String name)

public static PlaceholderDetails.PlaceholderSize[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

fullback to summary
public static final PlaceholderDetails.PlaceholderSize full
halfback to summary
public static final PlaceholderDetails.PlaceholderSize half
quarterback to summary
public static final PlaceholderDetails.PlaceholderSize quarter

Constructor Detail

PlaceholderSizeback to summary
private PlaceholderSize()

Method Detail

valueOfback to summary
public static PlaceholderDetails.PlaceholderSize valueOf(String name)
valuesback to summary
public static PlaceholderDetails.PlaceholderSize[] values()